Recently I’ve taken the time to update the API documentation for bookmarks.dev-api. I used the Swagger 2.0 (aka OAS 2) before and I decided to update to OpenAPI Specification (OAS) 3. In this post I will highlight the main points about the process and documenting the API with OAS 3. Some points might still apply to the former OAS 2 (fka Swagger) documentation, but they are worth mentioning since I hadn’t payed enough attention before and I find them useful.
Here are the key takeaways.