3-6. APIリファレンスの作成方法

3-6-1. APIリファレンスの作成フォーマットと作成例

商品の動きとgatewayの設定が正しいことを確認できたら、商品をマーケットに出すための審査申請を行います。

審査申請を行う際に「APIリファレンス」が必要となります

APIリファレンスのyamlはOpenAPI仕様で記述してください。

openapi: '3.0.0'
info:
  title: APIリファレンスサンプル
  version: 1.0.0
servers:
  - url: https://example.com
paths:
  /test:
    get:
      description: testパスの説明
      parameters:
        - name: sample query
          description: Sample Description
          in: query
          required: true
          example: 20200401
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                  type: object
                  properties:
                    status: 
                      description: sample
                      type: string
        '400':
          description: Bad request
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter market access token for API

※注意事項

・yamlのserversにはTellusのカスタマーに公開するURLを記載します。

・yamlのsecurityにはbearerAuthでマーケットトークンを渡す方式で記述してください(Tellusマーケット共通仕様です)。

APIの実装が完了しましたら、商品の「審査申請」を行ってください

次へ