![rspec-openapiのワークアラウンド
ログイン必須の場合は各メソッドの定義に手動で追記する必要がある
devise_token_authで認証用のgemを利用した場合
client,access_token,uidをヘッダにつける必要あり
各メソッドにつける
paths:
"/api/v1/shops":
get:
security:
- client: []
access_token: []
uid: []](https://image.slidesharecdn.com/slide-211220115411/85/Rails-REST-API-27-320.jpg)
RailsでのREST API開発の知見共有
- 2. 自己紹介 今 佑介@kon_yu 株式会社UZUMAKICTO 株式会社NoftyCTO 趣味 オンライン英会話 平日毎日レアジョブ 深夜ラジオ 最近のイチオシはマヂラブのANN クソアプリづくり
- 9. モックサーバを使ってスキーマ駆動開発がしたい OpenAPIversion3に対応したメジャーなモックサーバ Prism 使い方はとても簡単 > prism mock doc/openapi.yaml レスポンスはopenapi.yamlの各メソッドのexampleを返してくれる
- 10. TypeScriptのAPIアクセス部分を自動生成したい OpenAPIから各種言語のフロントエンドの自動生成 openapi-generator Rubyも生成できるし、Swift,Kotlin,Dartも生成できる TypeScriptの生成も様々なタイプができるAngular,Aurelia,Axios,Fetch,Inversify, jQuery,Nestjs,Node,redux-query,Rxjs) 生成コマンド(axios対応のTypeScriptの場合) > openapi-generator-cli generate -i ./YOUR_PATH/openapi.yaml -g typescript-axios -o openapi/types --additional-properties=modelPropertyNaming=camelCase,supportsES6=true
- 11. 自動生成されたコード例 async getShops() { state.isLoading = true const { data, error }: any = await new ApiV1ShopApi( undefined, $config.baseURL, axios as AxiosInstance ) .apiV1ShopsGet(1, 1000) .catch((error) => { return { error } }) state.isLoading = false if (error) { state.error = error return } state.shops = data.shops },
- 24. requestspec例 it"hogehoge"doの箇所がOpenAPIのdescriptionにこの分が反映されるのでrspecのいつも の書き方をすると違和感が出やすいので注意 RSpec.describe 'Tables', type: :request do describe '#index' do it 'テーブルの配列を取得する' do get '/tables', params: { page: '1', per: '10' }, headers: { authorization: 'k0kubun' } expect(response.status).to eq(200) end it 'does not return tables if unauthorized' do get '/tables' expect(response.status).to eq(401) end end # ... end
- 25. 生成されるOpenAPI定義ファイル例 openapi: 3.0.3 info: title: rspec-openapi paths: "/tables": get: summary: index tags: - Table parameters: - name: page in: query schema: type: integer example: 1 - name: per in: query schema: type: integer example: 10 responses: '200': description: returns a list of tables content: application/json: schema: type: array items: type: object properties: id: type: integer name: type: string # ...
- 28. 認証情報の定義 components: securitySchemes: client: type: apiKey description: ClientID in: header name: client access_token: type: apiKey description: access-token in: header name: access-token uid: type: apiKey description: uid in: header name: uid
- 29. rspec-openapiのワークアラウンド レスポンスがヘッダだけの場合不要な情報が付与されるので削除する必 要がある responses: '204': description: 商品カテゴリを更新 # これ以降を削除する content: '': schema: type: string example: '' responses: '204': description: 商品カテゴリを更新
- 30. rspec-openapiのワークアラウンド specを実行時にIDがインクリメントされるとパラメタが追加されてし まう letでidを指定してレコードを保存して実行すると、idがインクリメントされてparametersの 内容が増えてしまうため自動生成時に同じ入力パラメータが重複してエラーになる let(:category) { create(:category, name: '名前') } IDを指定してやる let(:category) { create(:category, id:1, name: '名前') }
- 31. rspec-openapiのワークアラウンド コンポーネントを自分で作らなければならない 自動生成されたもの responses: '200': description: 製品情報のリストを取得 content: application/json: schema: properties: products: type: array items: type: object properties: id: type: integer name: type: string
- 32. この状態だとコンポーネントを使わないとこのようなよろしくないクラス名になる /** * * @export * @interface InlineResponse2006 */ export interface InlineResponse2006 { /** * * @type {number} * @memberof Shop */ id: number; ... }
- 33. こういう意味の分かる名前のクラスを生成したい /** * * @export * @interface Shop */ export interface Shop { /** * * @type {number} * @memberof Shop */ id: number; ... }
- 34. そのためOpenAPI定義ファイルに responses: '200': description: お店のリスト取得する content: application/json: schema: properties: products: type: array items: "$ref": "#/components/schemas/Shop"
- 35. OpenAPI定義ファイルのコンポーネントの定義 components: schemas: Shop: nullable: true type: object properties: id: type: integer name: type: string
- 37. つまりここうなってしまう responses: '200': description: お店のリストを取得 content: application/json: schema: properties: products: type: array items: "$ref": "#/components/schemas/Shop" # せっかくコンポーネントを作ったのに下記の余分なものがついてしまう type: object properties: id: type: integer name: type: string