Tweet

Postman

Feb 7 • 17 tweets • 7 min read

Create amazing #developer experiences 🪐🪄🚀

A #thread 🧵

API publishers: follow these three steps to get started with a better developer experience for onboarding, educating, and inspiring your API consumers. ⬇️

@PetuniaGray

1⃣ Create good documentation with The Good Documentation Checklist from @PetuniaGray ✅✏️

blog.postman.com/postman-good-d…

2⃣ Set Up Your First Public Workspace in 5 Easy Steps 🛠️

blog.postman.com/how-to-set-up-…

3⃣ Link Your Docs to the Public Workspace for a Better Developer Experience 🔗

blog.postman.com/link-docs-to-p…

Now check out these examples of great public workspaces 👇

@MercedesBenz

✔️ @MercedesBenz Automotive Workspace

postman.com/mbdevelopers/w…

@joinbelvo

✔️ @joinbelvo open banking API for Latin America

postman.com/belvo-api-team…

@ArcGISApps

✔️@ArcGISApps Location Services

postman.com/arcgis-develop…

@MongoDB

Examples of custom environments, such as pre-filled environments via the Run in Postman button (see blog below).

👉 @MongoDB
👉 @joinbelvo
👉 @Meta

blog.postman.com/how-to-dynamic…

@getpostman

And now, check out these great examples of Run in @getpostman button placement 🚀

@Infobip

▶️ @Infobip bundles collection and environment in a workspace description

postman.com/infobip/worksp…

@okta

▶️ @okta provides a button for each API

developer.okta.com/docs/reference…

@brexHQ

▶️ @brexHQ provides a button for each API

developer.brex.com/docs/postman/#…

@Google

▶️ @Google styles the button in their brand theme

developers.google.com/maps/documenta…

Need more resources? We got you covered. More below.😎

👉blog.postman.com/design-your-st…
👉blog.postman.com/increasing-ado…

@getpostman

Thanks for reading! 👋🌌

Follow @getpostman more #developer and #API content.

• • •

Missing some Tweet in this thread? You can try to force a refresh

This Thread may be Removed Anytime!

Twitter may remove this content at anytime! Save it as PDF for later use!

More from @getpostman

Postman

@getpostman

Feb 8

Why use Postman for API #security? 🛡️🧵

✔️Enforce security rules on API definitions and requests

Postman API Security provides a set of default security rules, based on the OWASP “Top 10” for APIs, which will automatically surface common vulnerabilities and violations in your API landscape. blog.postman.com/introducing-ap…

✔️Customize security rules to fit your needs

Every organization is different, which is why Postman API Security enables teams to define and import custom rules according to Spectral guidelines.

Read 9 tweets

Postman

@getpostman

Feb 8

@apihandyman

8 traits of an effective #APIFirst design 🛠️✏️

Thread 🧵

(via @apihandyman 😎)

Before we get started, let's cover the basics.

✔️What is API-First?
✔️ What is API-First Design?

API-first is an organizational strategy and development model in which APIs are prioritized to deliver maximum value to the business. In this model, applications are designed and built by composing private, partner, or public APIs. postman.com/api-first/

Read 24 tweets

Postman

@getpostman

Jan 26

Best practices for creating API documentation 📄

#Thread below 🧵

✅Tell a compelling story

Every API plays a unique role in the software landscape of its producers and consumers, and API documentation tells this story. Readers should be able to learn who the API is meant for, how they can use it, and how it can help them achieve their goals.

This big picture provides important context for more technical implementation details, which can be useful as developers begin to understand the possibilities of a given API.