OpenApi - Java Annotation for Better Api Documentation

1

Swagger UI

OpenApi can be used to document a web api and Swagger-ui to display it in a user friendly way. The combination of both tools make it possible to play with the documented API to try it out and have a better understanding of what it does and how to use it.

#API Tools #APIs #Documentation 44 social mentions

2

Shields.io

Thanks to this documentation, the user knows what errors it might receive and the corresponding issues he needs to solve. The documentation also shows the "happy path" to retrieve the badge.svg and, in this particular example, the intermediary step to get one: the use of a third party HTTP API through a HTTP 303 See Other redirection – shield.io.

#API Tools #APIs #Developer Tools 72 social mentions