Skip to content

Commit

Permalink
chore: API仕様を確認する方法を追記
Browse files Browse the repository at this point in the history
  • Loading branch information
jiro4989 committed Feb 27, 2021
1 parent ab8a316 commit 180a61f
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,25 @@ masterブランチのCIが走るとリリースドラフトが生成されてし

`websh_serverディレクトリ配下のREADME`_ を参照。

API仕様の更新と確認
----

`public` ディレクトリ配下にWebshのAPI仕様を定義している。
API仕様が変わった場合は、こちらも合わせて更新する。
API仕様はOpenAPI 3.0.2を使用している。
API仕様はGitHub Pagesで閲覧できる。masterブランチが更新されると自動で反映される。

更新したswagger.yamlをローカルで確認する場合は、以下のコマンドを実行してローカル
でサーバを起動して確認する。

.. code-block:: shell
$ cd public
$ python3 -m http.server
サーバを起動したら http://localhost:8000/swagger.html を開いて画面が期待通り描画
されるかを確認する。

CI
----

Expand Down

0 comments on commit 180a61f

Please # to comment.