kmaull
/
talk_2016_may19_datapalooza_yourdataasaservice
1
0
Fork 0
Code Issues 0 Pull-Requests 0 Releases 0 Wiki Aktivität
Talk given at Datapalooza Denver 2016 titled "(Your) Data as a Service: The Easy Way to Build an API for Your Data".
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
6 Commits
1 Branch
3.7 MiB
 
 
 
 
 
Struktur: 1fcd13504a
Branches Tags
${ item.name }
Erstelle Branch ${ searchTerm }
von „1fcd13504a“
${ noResults }
talk_2016_may19_datapalooza.../code/server/apispec/data_api.yaml

108 Zeilen
2.5 KiB
Originalformat Blame Verlauf 

  1. swagger: '2.0'

  2. info:

  3.   title: Data API Example

  4.   version: "0.1"

  5. consumes:

  6.   - application/json

  7. produces:

  8.   - application/json

  9. #security:

  10. #  # enable OAuth protection for all REST endpoints

  11. #  # (only active if the TOKENINFO_URL environment variable is set)

  12. #  - oauth2: [uid]

  13. paths:

  14.   /:

  15.     get:

  16.       operationId: api_server.root

  17.       summary: Get root server response

  18.       responses:

  19.         200:

  20.           description: Return server information

  21.           schema:

  22.             type: array

  23.             items:

  24.               $ref: '#/definitions/Root'

  25. 

  26.   /summary/costs:

  27.     get:

  28.       operationId: api_server.get_summary_uris

  29.       summary: Get links for cost summary data

  30.       responses:

  31.         200:

  32.           description: Return summary links information

  33.           schema:

  34.             type: array

  35.             items:

  36.               $ref: '#/definitions/SummaryURI'

  37. 

  38.   /summary/costs/{year}:

  39.     get:

  40.       operationId: api_server.get_summary

  41.       summary: Get cost data for year

  42.       parameters:

  43.         - $ref: '#/parameters/year'

  44.       responses:

  45.         200:

  46.           description: Return cost information

  47.           schema:

  48.             $ref: '#/definitions/Costs'

  49. ## ALL PARAMETERS HERE

  50. parameters:

  51.   year:

  52.     name: year

  53.     description: Year of data

  54.     in: path

  55.     type: integer

  56.     required: true

  57.     pattern: "^[0-9]{4}$"

  58. 

  59. # ALL DEFINITIONS HERE

  60. definitions:

  61.   Root:

  62.     type: object

  63.     required:

  64.       - server_name

  65.     properties:

  66.       server_name:

  67.         type: string

  68.         description: Server name identifier

  69.         example: "data-one"

  70.         readOnly: true

  71.       time:

  72.         type: string

  73.         format: date-time

  74.         description: Creation time

  75.         example: "2015-07-07T15:49:51.230+02:00"

  76.         readOnly: true

  77.   SummaryURI:

  78.     type: object

  79.     properties:

  80.       year:

  81.         type: integer

  82.         description: Year of the data payload

  83.         example: "2010"

  84.         readOnly: true

  85.       link:

  86.         type: string

  87.         description: The resource link to the containing data

  88.         example: "/summary/costs/2010"

  89.         readOnly: true

  90.   Costs:

  91.     type: object

  92.     properties:

  93.       tuition_and_fees:

  94.         type: integer

  95.         description: Average annual tuition and fees costs

  96.         example: "10000"

  97.         readOnly: true

  98. #      room_and_board:

  99. #        type: integer

  100. #        description: Average annual room and board costs

  101. #        example: "2000"

  102. #        readOnly: true

  103.       books_and_supplies:

  104.         type: integer

  105.         description: Average annual books and fees costs

  106.         example: "2000"

  107.         readOnly: true