Skip to content
This repository has been archived by the owner on May 26, 2022. It is now read-only.

Create swagger specs and implement swagger UI #12

Closed
encX opened this issue Jul 30, 2020 · 0 comments · Fixed by #17
Closed

Create swagger specs and implement swagger UI #12

encX opened this issue Jul 30, 2020 · 0 comments · Fixed by #17

Comments

@encX
Copy link
Owner

encX commented Jul 30, 2020

Blocked by #14

Initial swagger specs

swagger: "2.0"
info:
  description: ""
  version: "1.0.0"
  title: "Bangkok Transit Planner API"
schemes:
- "https"
- "http"
paths:
  /stations:
    get:
      summary: Get all stations list
      produces:
        - application/json
      responses:
        200:
          description: Get success
          schema:
            type: array
            items:
              $ref: "#/definitions/station"
        500:
          description: Server error
  /routes:
    get:
      summary: Get all possible routes from station A to station B
      produces:
        - application/json
      parameters:
        - name: from
          in: query
          description: Starting station ID
          type: number
          format: int
          required: true
        - name: to
          in: query
          description: Ending station ID
          type: number
          format: int
          required: true
      responses:
        200:
          description: Get success
          schema:
            type: array
            items:
              $ref: "#/definitions/route"
        500:
          description: Server error
  
definitions:
  station:
    type: object
    properties:
      name:
        type: string
      id:
        type: number
        format: int

  route:
    type: object
    properties:
      cost:
        type: number
      stations:
        type: array
        items:
          $ref: "#/definitions/station"

https://editor.swagger.io/

@encX encX added this to backlog in Backlog via automation Jul 30, 2020
@encX encX changed the title Data model Data specs Jul 30, 2020
@encX encX changed the title Data specs Endpoint specs Jul 30, 2020
@encX encX changed the title Endpoint specs Create swagger specs Jul 30, 2020
This was referenced Jul 30, 2020
@encX encX changed the title Create swagger specs Create swagger specs and implement swagger UI Jul 30, 2020
@encX encX added M:3 and removed S:2 labels Jul 30, 2020
@encX encX added this to To do in Sprint 1 via automation Aug 2, 2020
@nantapong44 nantapong44 self-assigned this Aug 2, 2020
@encX encX mentioned this issue Aug 9, 2020
@encX encX closed this as completed in #17 Aug 9, 2020
Backlog automation moved this from backlog to done Aug 9, 2020
Sprint 1 automation moved this from To do to Done Aug 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Sprint 1
  
Done
Development

Successfully merging a pull request may close this issue.

2 participants