O'Reilly logo

Hands-On Full Stack Web Development with Aurelia by Erikson Haziz Murrugarra Sifuentes, Diego Jose Arguelles Rojas

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

API documentation

When you are working on a real project, the number of endpoints you will need to design will be higher. You will need a way to remember all your endpoints and the reason they were designed. Similarly, we are confident that documenting software is extremely important for us to remember what a piece of code is supposed to do; API documentation allows us to tell the API consumers how they can use our API by documenting the endpoints and other additional metadata, such as the ones listed:

  • Endpoint path
  • HTTP verbs
  • The expected headers
  • The expected body structure
  • The expected results
There is an awesome open source tool that helps you document and share the documentation with your APIs called Swagger. We encourage you to visit ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required