swaggerはapiドキュメントを生成します

apiドキュメントを生成することの重要性

現在、毎回100万のソフトウェアプロジェクト
があり
ます。apiを生成する場合は、自動化ツールに依存する必要があります。yamlに基づいてインターフェイスドキュメントを生成する方法の概要は次のとおりです。

サーバーをダウンロード

プロキシを設定する

# git clone http://...
git config --global http.proxy 'socks5://127.0.0.1:4781'
# git clone https://...
git config --global https.proxy 'socks5://127.0.0.1:4781'
# git clone git://...
git config --global core.gitproxy 'socks5://127.0.0.1:4781'

取消
git config --global --unset http.proxy

npm config set proxy=http://127.0.0.1:4780
npm config set registry=http://registry.npmjs.org
取消
npm config delete proxy
npm config delete registry

サーブテストサーバーをダウンロードする

sudo npm i serve -g

swaggerローカルエディターをダウンロードする

git clone https://github.com/swagger-api/swagger-editor

cd swagger-editor

//启动服务器
serve

yamlapiドキュメントに入れる例としてdockeryamlを取り上げます

dockerswarrer.yaml最

C:\Users\73444\Desktop\vsproj\moby\api\swagger.yaml

サーバーを実行した後

serve

   ┌─────────────────────────────────────────────────┐
   │                                                 │
   │   Serving!                                      │
   │                                                 │
   │   - Local:            http://localhost:5000     │
   │   - On Your Network:  http://172.27.96.1:5000   │
   │                                                 │
   │   Copied local address to clipboard!            │
   │

swarmer.yamlをコードにコピーし、[Generate html2]をクリックして、生成されたapiドキュメントを表示します。

生成されたローカルdockerapiドキュメント