{ "componentChunkName": "component---src-templates-blog-post-jsx", "path": "/post/dredd-supports-swagger/", "result": {"data":{"site":{"siteMetadata":{"title":"WEB EGG","author":"Leko - CTO at Yuimedi"}},"markdownRemark":{"id":"e68a7d78-a192-5812-930a-41f2b9e13a67","excerpt":"以前に APIドキュメントでAPIサーバをテストする | WEB EGG という記事を書いたときに紹介したDreddですが、 いつのまにか自社サービスのApiaryだけでなくSwagger(OpenAPI v…","html":"

以前に

\n
\n

APIドキュメントでAPIサーバをテストする | WEB EGG

\n
\n

という記事を書いたときに紹介したDreddですが、
\nいつのまにか自社サービスのApiaryだけでなくSwagger(OpenAPI v2)にも対応していたそうです。

\n

ついでにロゴも洗練されてかっこよくなってます。

\n

自分で書いた過去記事の末尾でも軽く触れていますが、
\nOpenAPI initiativeも未だ活動続いてますし、「乗るしか無い、このビッグウェーブに」といったところなんでしょうか。
\nなんにせよApiaryにロックインすることなく、Swaggerで記述した仕様書がテストできるようになったというのは嬉しいことなので早速試してみました。

\n\n

Dreddをインストール

\n

READMEのとおりです。

\n
npm install -g dredd
\n

Swaggerのデモ仕様書を作成

\n

まずはミニマムで試してみたいので、ドキュメントにあるやつをそのままパクります。

\n
swagger: \"2.0\"\ninfo:\n  version: \"1.0\"\n  title: Example API\n  license:\n    name: MIT\nhost: www.example.com\nbasePath: /\nschemes:\n  - http\npaths:\n  /:\n    get:\n      produces:\n        - application/json; charset=utf-8\n      responses:\n        200:\n          description: \"\"\n          schema:\n            type: object\n            properties:\n              message:\n                type: string\n            required:\n              - message
\n

ちなみにOpenAPI v3(OpenAPI.nextブランチ)には対応してないのか調べてみたのですが、してないようでした。
\nまぁまだスキーマ定義もサンプル仕様も存在しないし仕方ないと思います。

\n

デモアプリ作成

\n

同じくドキュメントからパクります。

\n
var app = require('express')();\n\napp.get('/', function(req, res) {\n  res.json({message: 'Hello World!'});\n})\n\napp.listen(3000);
\n

ごく簡単なechoサーバです。

\n

いざDredd実行

\n

ドキュメント

\n
$ dredd swagger.yml localhost:3000\ninfo: Beginning Dredd testing...\npass: GET / duration: 56ms\ncomplete: 1 passing, 0 failing, 0 errors, 0 skipped, 1 total\ncomplete: Tests took 64ms
\n

はい、いい感じです。さすがDredd。

\n

AWS API GatewayのデモAPIを使ってみる

\n

もうちょい実用向けのサンプルも欲しいところです。
\nSwaggerといえば、AWS API Gatewayでしょう。
\nAPI GatewayはデフォルトでSwaggerのPetstoreというサンプル仕様書を作成してくれます。
\nということで、これもテストしてみます。

\n
    \n
  1. AWSのコンソールでAPI Gatewayを有効化
    2. \n
  2. Petstore APIがデフォルトで入力されてるのでそのままインポート
    3. \n
  3. 作ったAPIをデプロイ
    4. \n
  4. Swaggerの仕様書をエクスポート
    5. \n
\n

でAPIのエンドポイントとswaggerの仕様書を入手して、試してみます。
\nエクスポートした仕様書はYAML形式でswagger.ymlというファイル名で保存しました。

\n

{XXXXXXXXXXX}, {STAGE}は自分で入力した内容になります。

\n
$ dredd swagger.yml https://{XXXXXXXXXXX}.execute-api.ap-northeast-1.amazonaws.com/{STAGE}\nerror: Compilation error in file 'swagger.yml': Required URI parameter 'petId' has no example or default value. ( > /beta/pets/{petId} > GET)\nerror: Compilation error in file 'swagger.yml': Required URI parameter 'petId' has no example or default value. ( > /beta/pets/{petId} > OPTIONS)\nwarn: Compilation warning in file 'swagger.yml': Ambiguous URI parameter in template: /beta/pets/{petId}\nNo example value for required parameter in API description document: petId ( > /beta/pets/{petId} > GET)\nwarn: Compilation warning in file 'swagger.yml': Ambiguous URI parameter in template: /beta/pets/{petId}\nNo example value for required parameter in API description document: petId ( > /beta/pets/{petId} > OPTIONS)\nerror: Error when processing API description.
\n

あら。エラーになってしまいました。
\nPetStoreの仕様書自体に問題があるようです。

\n

これを治すのは本筋じゃない感じがしたので、いったんここまでで止めておきます。
\nAPI GatewayとLambdaをベースにしたサーバレスなAPIサーバとかも、簡単に受け入れテストできるようになるので、便利だと思います。
\nDreddがApiary(API Blueprint)ではなくSwaggerに対応したことは大きな意味を持つと思います。

\n

尻切れトンボですみません。

","timeToRead":4,"frontmatter":{"title":"HTTP APIのテストツールDreddがSwaggerに対応していたので試してみた","tags":["API","AWS API Gateway","Dredd","OpenAPI","Swagger"],"date":"March 21, 2017","featuredImage":{"childImageSharp":{"fluid":{"tracedSVG":"data:image/svg+xml,%3csvg%20xmlns='http://www.w3.org/2000/svg'%20width='400'%20height='144'%20viewBox='0%200%20400%20144'%20preserveAspectRatio='none'%3e%3cpath%20d='M56%2040L39%2051l-1%2021c0%2020%200%2020%205%2023%202%202%203%203%203%208v13l3-3%204-2%201-4v-5l9%205c11%206%2011%206%2022%200l9-5v4c0%204%201%205%207%209l1-9c0-8%200-8%202-10%206-5%206-3%206-24l-1-20c0-2-33-21-35-21l-18%209m2%201l-15%209-3%202v19c0%2018%200%2020%202%2021%201%202%202%201%202-12V66l3-8c8-15%2018-21%2032-18%209%202%2015%206%2019%2015l5%209c1%201%202%2014%201%2022-1%207%201%209%203%205%202-3%201-37%200-39-2-3-32-19-34-19l-15%208m81%2010l1%207%204-1c5%200%208-2%208-6%200-5-3-7-8-7h-5v7m15%200c0%204%201%206%202%207l1-2c0-4%203-4%204%200l3%202v-3c-1-1-1-3%201-4%202-5%200-7-6-7h-5v7m26%200c0%208%201%208%208%206%208-3%205-13-4-13h-4v7m15%200v7h4c11-2%2011-14%200-14h-4v7M65%2053v4h9c9%200%209%200%209-2l1-4c0-2-1-2-10-2H64l1%204m0%2049l-5%201%206%203%208%204%2013-7c0-2-13-2-22-1'%20fill='%23d3d3d3'%20fill-rule='evenodd'/%3e%3c/svg%3e","aspectRatio":2.760330578512397,"src":"/static/9cad1bffef3544de1301b710dc364e06/8eab8/featured-image.png","srcSet":"/static/9cad1bffef3544de1301b710dc364e06/1ec58/featured-image.png 334w,\n/static/9cad1bffef3544de1301b710dc364e06/ccb4a/featured-image.png 668w,\n/static/9cad1bffef3544de1301b710dc364e06/8eab8/featured-image.png 1336w,\n/static/9cad1bffef3544de1301b710dc364e06/a3884/featured-image.png 1772w","srcWebp":"/static/9cad1bffef3544de1301b710dc364e06/f7e47/featured-image.webp","srcSetWebp":"/static/9cad1bffef3544de1301b710dc364e06/cd98f/featured-image.webp 334w,\n/static/9cad1bffef3544de1301b710dc364e06/7535d/featured-image.webp 668w,\n/static/9cad1bffef3544de1301b710dc364e06/f7e47/featured-image.webp 1336w,\n/static/9cad1bffef3544de1301b710dc364e06/edb99/featured-image.webp 1772w","sizes":"(max-width: 1336px) 100vw, 1336px"}}}}}},"pageContext":{"slug":"/dredd-supports-swagger/","previous":{"fields":{"slug":"/dockerize-friends-lang/"},"frontmatter":{"title":"すごーい！きみはフレンズ言語をDockerizeできるフレンズなんだね！","tags":["Docker","F#","Github","Mac"]}},"next":{"fields":{"slug":"/introduction-of-raspberry-pi-with-gui/"},"frontmatter":{"title":"Raspberry pi 3 Model BでGUIを起動してインターネットに繋がるまでの手順","tags":["RaspberryPi"]}}}}, "staticQueryHashes": ["2585454260","2954598359"]}