feat: open-trip-api-drink (#11)
All checks were successful
Build Docker Image Front / run (push) Successful in 28s
Build Docker Image Back / run (push) Successful in 23s

Reviewed-on: #11
Co-authored-by: Clement <c.boesmier@aptatio.com>
Co-committed-by: Clement <c.boesmier@aptatio.com>
This commit is contained in:
2024-05-19 11:38:38 +02:00
committed by Clement
parent 1bbc7a2aa3
commit e0c3580269
24 changed files with 1951 additions and 27 deletions

View File

@ -1,3 +1,4 @@
import { getCity, getRadius, getPoiId, getBox } from "./openTripMaps"
import express from "express"
/**
* Initialize Express application instance.
@ -22,6 +23,7 @@ function getWelcome(req: express.Request, res: express.Response) {
* @openapi
* /welcome:
* get:
* summary: retun just hello
* description: Welcome to swagger-jsdoc!
* responses:
* 200:
@ -29,4 +31,137 @@ function getWelcome(req: express.Request, res: express.Response) {
*/
app.get("/welcome", getWelcome)
/**
* @openapi
* /otm/city:
* get:
* summary: return the drinks in a city
* description: return the drinks in a defined perimeter in a city
* parameters:
* - name: name
* in: query
* required: true
* description: the name of the city
* schema:
* type: string
* responses:
* 200:
* description: Return a list of bars and coffee in city in geoJSON format
* 400:
* description: Missing Argument Error
* 401:
* description: Missing OTM tocken
*/
app.get("/otm/city", getCity)
/**
* @openapi
* /otm/radius:
* get:
* summary: return the drinks in a radius
* description: return the drinks in a defined radius
* parameters:
* - name: lon
* in: query
* required: true
* description: longitude of the center of the radius
* schema:
* type: number
* minimum: -180
* maximum: 180
* - name: lat
* in: query
* required: true
* description: latitude of the center of the radius
* schema:
* type: number
* minimum: -90
* maximum: 90
* - name: radius
* in: query
* description: size of the radius
* responses:
* 200:
* description: Return a list of bars and coffee in city in geoJSON format
* 400:
* description: Missing Argument Error
* 401:
* description: Missing OTM tocken
*/
app.get("/otm/radius", getRadius)
/**
* @openapi
* /otm/poidetaill:
* get:
* summary: detail of a POI
* description: detail of a POI link name, kind, rate,...
* parameters:
* - name: id
* in: query
* required: true
* description: Unique identifier of the object in OpenTripMap
* schema:
* type: string
* responses:
* 200:
* description: Return the detaill of an POI in otm
* 400:
* description: Missing Argument Error
* 401:
* description: Missing OTM tocken
*/
app.get("/otm/poidetaill", getPoiId)
/**
* @openapi
* /otm/box:
* get:
* summary: return the drinks in a box
* description: return the drinks in a defined box
* parameters:
* - name: lon1
* in: query
* required: true
* description: longitude 1 of the box
* schema:
* type: number
* minimum: -180
* maximum: 180
* - name: lat1
* in: query
* required: true
* description: latitude 1 of the box
* schema:
* type: number
* minimum: -90
* maximum: 90
* - name: lon2
* in: query
* required: true
* description: longitude 2 of the box
* schema:
* type: number
* minimum: -180
* maximum: 180
* - name: lat2
* in: query
* required: true
* description: latitude 2 of the box
* schema:
* type: number
* minimum: -90
* maximum: 90
* responses:
* 200:
* description: Return a list of bars and coffee in city in geoJSON format
* 400:
* description: Missing Argument Error
* 401:
* description: Missing OTM tocken
*/
app.get("/otm/box", getBox)
export default app