Welcome to the reference guide for how to build API first with Postman! This is the follow along guide to my blog post, so if you want more detail on what you're looking at, hop over there!
Introduce newbies to definine an API before writing any code. With OpenAPI Specification (OAS), you can define all aspects of an api. The data shape, the endpoints, security (not included in this example), and expected responses.
When at all possible, you should use industry standard technology and specifications. OpenAPI is just that. It is used by major companies like Google, Microsoft, and IBM.
Learning how to write in the spec not only provides the developer with a useful skillset, but it also provides other developers a familiar experience.
Postman stitches together the OAS definition with robust functionality like mock servers, web tests, and documentation right out of the box. The blog post walks you through how to set it up and start testing.
In this repo you will find:
- OAS3.0 spec defining the Gopher Holes Unlimited API. It contains the endpoints, component schemas, and example responses
- 3 Postman Collections
- Mock Server Collection
- Documentation Collection
- Test Suite/Automation Collection
The Postman collections are intended to be consumed from Postman itself, and is highly recommended you import them into your workspace to get the full effect.
Below is an auto-generated infrastructure diagram describing the serverless API built by the SAM template in this repository. The resources outlined in the diagram below will be deployed into your AWS account.
If you like this repo and the accompanying blog post, show your support by following me on Twitter or connecting with me on LinkedIn. I'm always happy to answer any questions you might have and am open to any ideas you'd like to see turned into an article on my blog!