Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article?
This post is authored by Phil Sturgeon, product manager, Stoplight, and Chairperson, Protect Earth. If you’d like to donate to Phil’s charity of choice, please see Protect Earth which is reforesting the U.K. one field at a time. OpenAPI v3.1 brings a lot of great new functionality and improvements, and at some point in the near future you might find yourself wanting to upgrade. If you’re ready to
訳者序文 このドキュメントは正式な日本語訳ではありません。また、Zennの記事の上限である 80,000 文字に収めるために、YAML と併記されていた一部の JSON の例を省略しました。 オリジナルと同様、The Apache License, Version 2.0 の下でライセンスされます。 正式な仕様書を必要としている方は、以下を参照ください。 OpenAPI 仕様 Version 3.1.0 このドキュメント内のキーワード "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", および "OPTIONAL" は、ここで示したように全て大文字で表記される場合、また、その場合のみ BCP 14 RFC2
OpenAPI記述 定義したモデルとAPI仕様をOpenAPIで記述していきます。 info, host, schema, securityなどの項目は省略しています。 コードは以下のバージョン指定で確認しています。 OpenAPI 3.0.1 Swagger Editor v3.15.10 OpenAPIバージョンはspecファイルの先頭で、Swagger EditorバージョンはDocker版のタグで指定しました。 基本的にはオンラインのSwagger Editorに貼り付けて動作するはずです。 STEP1. 取得可能属性でschemaを定義してリクエストは個別に定義する まずは最も使う頻度が多い返却データの形式でschemaを定義してレスポンスで利用します。 リクエストごとに異なる形式は個別に記述します。 openapi: 3.0.1 info: title: "STEP1" des
はじめにOpenAPI仕様に則ってREST APIの設計をする際に、値が存在しないという状態をどのように表現するかというお話です。 undefinedとはまずはじめに、ここでundefinedと言っているのは、OpenAPIの仕様において、リクエスト/レスポンスのデータ型を定義するSchema Objectのプロパティの1つであるrequiredが指定されていない状態を指します。 OpenAPIにおけるrequiredの定義を確認してみましょう。 OpenAPIの仕様を参照すると、Schema ObjectはJSON Schemaの仕様に従うと記載されています。 The Schema Object allows the definition of input and output data types. These types can be objects, but also primit
2019/03/18 この記事は書かれてから1年以上が経過しており、最新の情報とは異なる可能性があります techAPIOpenAPI 現時点での OpenAPI に関する知識の棚卸しをした方がいいかなと思ったので書きます。 前提使い方が 100% 定まっているわけではありません少なくとも OpenAPI を使っていくこと自体は間違ってないという考えで使っていますGraphQL については触れませんOpenAPI とは何か？ 端的に言うと、 RESTful API に関するインターフェース定義 です。 一方で、そのインターフェース定義は YAML ファイルもしくは JSON ファイルで表されるため、 単なる YAML (JSON) ファイル だということもできると思います。 その仕様に沿って書くことで、周辺ツールであれこれ便利なことができます。 こんな便利なことができる定義ファイルを元にド
はじめに API仕様書をOpenAPIで定義する際にファイル分割してメンテナンスしやすくしようという話です。 OpenAPI定義はVSCodeで作成していきます。 VSCodeでOpenAPI定義ファイルを作成する際に便利な拡張機能については以下の記事にまとめてあります。 https://zenn.dev/yamatonokuni/articles/bd547c74fe9007 本記事の定義例をVSCodeで表示したプレビューです。 最終的なファイル分割構成 openapi ................................ Rootディレクトリ │ ├─components ......................... Components Objectを格納するディレクトリ │ ├─examples ........................ Example
ポエムです。コードが1行も出てこないので じっちゃん に怒られそうです。 Remote Procedure Call(RPC)に長年興味を持ち、実案件で使ってきました。 RPC は、ネットワーク上にあるロジックを関数呼び出しで実行することができ、通信のためのコードを隠蔽する技術と考えています。 RPCに関し、OpenAPI Specification(Swagger Codegen)に辿り着くまでの道を振り返ってみました。 CORBA www.corba.org Common Object Request Broker Architecture 様々なプログラミング言語で書かれたソフトウェアコンポーネントの相互利用を可能にするもの（分散オブジェクト技術） サポートされる異言語間の通信が可能 IIOP というプロトコルを使っている CORBA の歴史は長いみたいですが、私が実案件で使ったのは
OpenAPI Generator CLI を使ってみた RESTful な API を記述するためのフォーマットとして、OpenAPI というモノがある。以前は Swagger と呼ばれていて、Swagger 2.0 をベースに拡張・改称されたのが OpenAPI らしい。特に OpenAPI だから、Swagger だからという違いはないみたいで、名称は気にしなくて良さそう。 OpenAPI は YAML ないしは JSON 形式で API 仕様書を記述するのだが、それを HTML 化するツールとして Swagger UI というモノがある。 そして今回試すのは、YAML や JSON で書いた仕様書を基に、色々なプログラミング言語でのコードを自動生成してくれるツールである、OpenAPI Generator CLI である。 OpenAPITools/openapi-generato
こんにちは、 Gaji-Labo アシスタントエンジニアの石垣です。 今回は OpenAPI の定義ファイルを Stoplight Studio で書く機会があったため、自身の理解を深めるためにも OpenAPI と Stoplight Studio についてまとめてみます。 OpenAPIとは？OpenAPI は、REST APIの定義を記述するためのフォーマットである「OpenAPI Specification」の略称です。元々「Swagger」という REST API を設計、構築、文書化、および使用などを行うためのフレームワークが存在し、そこで用いられていたフォーマットが標準化されたものが OpenAPI のようです。 スキーマ駆動開発で分離されているバックエンドとフロントエンドの実装を繋ぎこむために OpenAPI が用いられます。 OpenAPI の定義は JSON や YAM
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く