I will write clear API documentation and openapi swagger specs for your rest api


About this gig
Developers judge your API by its documentation. Unclear docs mean more support questions and fewer integrations.
I'm a software architect with 7+ years as a software engineer before that, and I've built and consumed many APIs. I'll turn your code, Postman collection or notes into documentation developers can use straight away.
WHAT YOU GET
- Overview, authentication and getting-started guide
- Every endpoint: method, path, parameters, request and response bodies
- Example requests and responses (cURL, JavaScript, Python)
- Error codes and how to handle them
- OpenAPI 3 (Swagger) specification on Standard and Premium
- Rate limits, pagination and versioning notes
WORKS WITH
REST and JSON APIs built in Node.js, Python, Java, .NET, Go, PHP and more. I can work from source code, an existing spec, a Postman collection or a call with your team.
Message me with your number of endpoints and I'll confirm the right package.
Get to know Steve Duvenage
Software Architect
- FromSouth Africa
- Member sinceMar 2023
- Avg. response time1 hour
Languages
English, Afrikaans
Other Software Development Services I Offer
FAQ
• What do you need from me?
Source code, an existing spec, a Postman collection or a test environment. Any one is enough to start.
• Can you document GraphQL?
Yes, message me first so I can quote for it.
• Can you publish the docs?
I deliver files ready for Swagger UI, Redoc, ReadMe or Postman. Hosting is up to you.

