Our great sponsors
-
openapi-generator
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
-
swagger-ui
Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
Documentation is everything that the engineering team writes. It is, however, kind of ignored by other developers. And there are several reasons for this, for example, poorly documented or outdated information. The good news is that there are good tools that can help us on this documentation journey. Swagger, for example, greatly simplifies this process for us. There is also the Open API whose objective is to create a specification for the APIs, bringing several advantages in addition to the documentation. With a little help, it is possible to generate an SDK for several languages from the Open API. For example, if you are from the Java world you can add code generation with a maven plugin. And it is possible to generate this SDK for several languages. In addition to automatically generating the APIs SDK, there is the option to create manually. Despite the work, there is the possibility of polishing this SDK with, for example, DSL and Fluent APIs concepts. In this approach it is worth using the language documentation if you use Java or JavaDoc, for example.
Documentation is everything that the engineering team writes. It is, however, kind of ignored by other developers. And there are several reasons for this, for example, poorly documented or outdated information. The good news is that there are good tools that can help us on this documentation journey. Swagger, for example, greatly simplifies this process for us. There is also the Open API whose objective is to create a specification for the APIs, bringing several advantages in addition to the documentation. With a little help, it is possible to generate an SDK for several languages from the Open API. For example, if you are from the Java world you can add code generation with a maven plugin. And it is possible to generate this SDK for several languages. In addition to automatically generating the APIs SDK, there is the option to create manually. Despite the work, there is the possibility of polishing this SDK with, for example, DSL and Fluent APIs concepts. In this approach it is worth using the language documentation if you use Java or JavaDoc, for example.