sakamomo554101 / YouyakuAI

日本語用の要約を行うデモサービス

0 stars 0 forks source link

Closed sakamomo554101 closed 3 years ago

sakamomo554101 commented 3 years ago

対応内容

要約APIのドキュメントの作成（FastAPIの自動生成で良さそう）

sakamomo554101 commented 3 years ago

https://github.com/tiangolo/fastapi/issues/785 swagger UIでAPIは見れるが、上記のようにエクスポートもできそう？

sakamomo554101 commented 3 years ago

http://localhost:8000/docs 上記で、APIドキュメントが見れる。

下記を追加したい。

sakamomo554101 commented 3 years ago

おぉ、まさに知りたかったこと

sakamomo554101 commented 3 years ago

さっきの記事もそうだが、ステータスコード200で、複数の詳細コードを返す場合はどうすればいいんだろ？処理が終わってない、とかはHTTPステータスコードとしては200で正常に取得できているが、データパターンとしては、どこかにAPI仕様情報として定義する必要がある。

なるべくドキュメントは一つでまとめたいから、swaggerで作成されるAPI仕様にまとめたい・・

sakamomo554101 commented 3 years ago

sakamomo554101 commented 3 years ago

https://techblog.zozo.com/entry/go-openapi-response-validation ほー、ステータスコードにx-をつけて、拡張できるのか（OpenAPIの仕様）もうちょっと調べてみる

sakamomo554101 commented 3 years ago

sakamomo554101 commented 3 years ago

sakamomo554101 commented 3 years ago

componentsでschema定義して、responseの200の際のパターンを入れればいいかなー

sakamomo554101 commented 3 years ago

sakamomo554101 commented 3 years ago