Build OpenAPI Specification Swagger file(s) - Githubissues

ruxandrailiescu / bug-tracking-web-app

MIT License

1 stars 0 forks source link

Build OpenAPI Specification Swagger file(s) #1

Open meteabduraman opened 1 day ago

meteabduraman commented 1 day ago

Have a Swagger file for the API/one for each of the APIs. A Swagger file helps clients that want to use your API to know how to communicate with it and what to expect as responses (it discloses information about the available endpoints, request bodies, response status codes, etc.)

❗️This is needed for the 2nd phase of the Project, due December 5th, 2024❗️ ❗️Checkout more details about the assignment on online.ase.ro❗️

Checkout this example.

Additional links:

OpenAPI standard definition
express-openapi npm library for automatic creation of Swagger files
Swagger Online Editor helping to manually build the Swagger file

This file (or .zip archive of files) then should be uploaded on online.ase.ro.

meteabduraman commented 1 day ago

@ruxandrailiescu can you link your Github Project to this repository? You can also mark this issue as part of the project when you manage to link them 🤔