On the importance of API docs

Not toucing Developer Experience and Documentation. IDK if it’s that necessary.

Swagger/OpenAPI 3.0 is deployed at https://blog-backend-psi-rosy.vercel.app/api-docs.

It’s very basic, QA-wise, but features can be added there.

Took a while to deploy Swagger’s CSS on Vercel, and the solution is a hackjob.

Swagger is a great manual testing tool on it’s own. The point is to get it running first.

Since the BE is not working yet, I’ll add some integration tests with a reports server. And then do some fast TDD debug. And once api stabilizes, I’d add contract tests. It doesn’t take much time, but helps preventing errors. And then we can look into the security holes in the app. ;)

Things missing

• API versioning strategy (well, we don’t a version bump, too.)
• Documentation for multiple API versions
• Swagger validation

On the code smell

The code is bad, but the fun is fixing it with tests.