![]() Let’s say you create a new request in Postman Collection and set its URL to something like . Assign a User Friendly and Unique Name to Your Postman Requests In this blog, I share a few tips to gear your API documentation and SDKs towards your developers from as early as your starting point - Postman requests and the resulting Postman Collection. You can then easily export your API requests in the form of a Postman Collection file and use it to generate complete API documentation as well as SDKs. Postman is a tool widely used by developers for API testing and for collaborating over APIs with teams. This implies that user-friendliness is a key factor in determining the quality of your API developer experience program. Similarly, a good quality SDK is one which is usable, idiomatic, comes bundled with language-specific documentation and is simple enough to be used by any average developer. So, naturally, your API documentation can only be termed “good quality” if it comes with a human element in it- easy to read, navigate and comprehend. Who are the end-users of a documentation, really? Humans. ![]() After all, it is one of the critical pieces of any good developer experience program along with platform SDKs, code samples etc. Are you looking to provide a smooth developer experience with your APIs and as a result maximize API consumption? Then, you can’t really afford to put off API documentation as a last thought.
0 Comments
Leave a Reply. |