コード日進月歩

しんくうの技術的な小話、メモ、つれづれ、など

swagger

swagger/OpenAPI 3.0で本番と検証用のURLを明示的に示す

ずっと記載分けができないものだと思っていた。 書き方 下記のドキュメントにある。 API Server and Base Path | Swagger serversというセクションがあり、そこは配列指定できるのでそちらを使う。この書き方にすると、SwaggerUIでもアクセス先切り替えがで…

swaggere3.0で独自の認証用ヘッダを定義する

例えばカスタムヘッダでそこに認証用のキーを埋め込んでほしい場合などの書き方。OAuthとかBasic認証はあるのだけど、そういうポピュラーなものではなくオリジナルをやりたい場合の例。 書き方 securitySchemes にtypeを apikey にした情報を定義する 利用し…

swaggerのJSONからyamlの形式に作り直す

swaggerのJSONからyamlへの変換方法を考えたが、これが一番楽だということに気づく やり方 YAMLに置き換えたいJSONを用意する Swagger Editorにアクセス File から Import file する YAMLができあがる 注意点 バージョン違いのswaggerで作られたJSON出力を読…

OpenAPI3.0でバイナリ送付のエンドポイントを書く書き方

swaggerの書き方シリーズ 環境 openapi: 3.0.2 書き方 content: multipart/form-data: description: "画像登録するときのマルチパートフォーム情報" type: object properties: fileName: description: "ファイル名" type: string example: "example.png" ima…

OpenAPI3.0で使うcomponentsの種類をざっくりまとめる

Swaggerと呼ばれたりOpenAPIと呼ばれたりするOpenAPI Specification。どれが何やねん、ってなるのでメモ。 環境 openapi: 3.0.0 componentsセクションの種類 記述名 用途 schema 具体的なオブジェクト parameters APIのパラメータ、クエリストリングやパスパ…