Back
3-6. How to create an API reference

3-6-1. API reference creation format and examples

After confirming that the product is functioning correctly and gateway settings are correct, submit the application for review in order to list the product on the market.

An "API reference" is required when applying for review.

The yaml of the API reference should be written in the OpenAPI specification.

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

*Notes

- For the yaml servers, specify the base URL that you want to release to the Tellus customers.

- Please use bearerAuth to pass the market token to yaml security (a common specification in the Tellus Market).

After completing the API implementation, please submit a review application for the product.