0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

swagger(open api) をはじめる

Last updated at Posted at 2019-05-10

このページについて

Macとvscode に swagger の開発環境を構築し、api document を作るまでが書いてあります

背景

api仕様書を書くのにblueprintを使っていますが、他のも試してみたくなったからです(私が選定していないため)

agreedという定義を簡単にかけるやつ使ってみましたが
制約などの書き込みができなかったので採用を見送りました(必須制約入れられないの辛い)

ゴール

こんなドキュメントが作れるようになります

スクリーンショット 2019-05-10 14.09.03.png

手順

vscodeの設定

  • yaml extention のインストール
  • 設定ファイルに追加記述
"yaml.schemas": {
    "https://raw.githubusercontent.com/kogosoftwarellc/open-api/master/packages/openapi-schema-validator/resources/openapi-3.0.json": ["*swagger.yaml", "*swagger.yml"],
},
  • swagger viewer のインストール
    • Shift + Alt + P でyamlに記述したdocのpreviewが可能になります

書き方

yamlの内容をhtmlにしたい

誰かに渡すときに必要ですよね

$ docker run -i yousan/swagger-yaml-to-html < your-swagger.yml > ./build/index.html

swagger-codegenのインストール

(クライアントなど必要であれば)

$ brew cask install adoptopenjdk8 && \
brew instal swagger-codegen

参考

0
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
1

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?