Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 603 Bytes

README.md

File metadata and controls

21 lines (14 loc) · 603 Bytes

Challenge 05 🚀

💻 Description

This challenge aimed to document the API created in the previous challenge (challenge 04), using Swagger.

📝 What should I document?

The documentation should serve as a description of your API's inputs and outputs. Below we suggest the main points that you should document:

  • General API information (name, description, etc.);
  • routes;
  • Parameters;
  • Requisition Body;
  • Successful responses;
  • Error responses;
  • Examples.

Use Enter the project folder and run the yarn command. With the dependencies installed, I ran yarn dev to upload the server.