REST - RESTful APIデザインの標準ファイル形式は何ですか？

Question

私のデザインをバージョン管理のためのファイルとして保存したいと思います。

標準または一般的に使用されている形式はありますか？

User { 
    uid, 
    name 
} 

そして、APIの定義のための別のファイル：

GET /users/:uid => User 
GET /users?name=:name => [User] 

は、しかし、これらは私の好みである

例えば、私は1つの構造定義のファイルを書き込むことができます。これらを表現するために一般的に使用されるフォーマットはありますか？

言語にかかわらず、API自体に重点を置いて、それはUMLのようなものになると期待しています。

Answer 1

あなたが言及している表記は、開発者がデザインや仕様として期待するものに非常に近いので、十分かもしれません。

しかし、あなたのプロジェクトが一定のスケールを取得する場合は、コード生成、テスト、またはドキュメントを自動化するツールで使用される表記法を使用することができます。

特に、スワッガーはこれに使用するのに非常に一般的なツールです。これらの標準に従って仕様書を書くと、そのツールを使用すればドキュメントやコード生成さえも得られます。

https://swagger.io/specification/