openapi

About Swagger Specification | Documentation | Swagger

gRPC や Connect: A better gRPC を検討しても良いかもしれない

ディレクトリ構成

path などに分割する方法が紹介されているが、バージョンごとの定義の違いはどうやって表現するのかについての情報が全然ない。

path/v1 みたいにやっている人もいるが、その場合、変更がない部分については以前のバージョンのディレクトリからまるまるコピーしてくるだけになるのか？

コピーするのなんかやだ

差分がわかりずらいのでレビューがちょっと手間では？

ネストしない人はどうしているんだ？

ReadableなOpenAPI定義ファイルを書く - ドワンゴ教育サービス開発者ブログ

これとかもバージョン更新について考慮されていなくないか？

ちゃんと定義できる

OpenAPI Specification - Version 3.1.0 | Swagger

nodejs

openapi/openapi: Generate JavaScript or TypeScript code from Swagger/OpenAPI specifications

You can find examples of API at Public API documents.

merge objects

Inheritance and Polymorphism | Swagger Docs

json schema

format (2020-12)

スキーマファースト開発のためのOpenAPI（Swagger）設計規約 | フューチャー技術ブログ

SmartHR API

github/rest-api-description: An OpenAPI description for GitHub's REST API

components で responses を使う

Describing Responses | Swagger Docs

header can be defined as parameter

Parameter Serialization | Swagger Docs

parameters can be a component

Components Section | Swagger Docs

Code generate

OpenAPITools/openapi-generator: OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

nix で openapi-generator-cli を使うには

NixOS Search - Packages - openapi-generator-cli

generator の実装

openapi-generator/CONTRIBUTING.md at master · OpenAPITools/openapi-generator

部分生成

openapi-generator/docs/customization.md at v7.12.0 · OpenAPITools/openapi-generator

rust

Documentation for the rust-server Generator | OpenAPI Generator

github readme には rust-server で stub が生成されると書かれているが、多分作られない。実装のない example だけに思える。

Documentation for the rust-axum Generator | OpenAPI Generator

client もある

issue

axum

Issues · openapitools/openapi-generator

Issues · openapitools/openapi-generator

beta の意味

FAQ · OpenAPITools/openapi-generator Wiki

stoplightio/prism: Turn any OpenAPI2/3 and Postman Collection file into an API server with mocking, transformations and validations.

Sample がある

openapi-generator/samples/server/petstore/rust-axum/output/openapi-v3 at v7.9.0 · OpenAPITools/openapi-generator

これはどの yaml を元に生成している？

ここ

openapi-generator/modules/openapi-generator/src/test/resources/3_0/rust-server/openapi-v3.yaml at v7.9.0 · OpenAPITools/openapi-generator

なぜわかるかというと

こういう感じで config がある

https://github.com/OpenAPITools/openapi-generator/blob/master/bin/configs/rust-server-openapi-v3.yaml

PR に、テストしましたよという感じで書いてあった