Public workspace linter

Number of APIs: 7

Is your public workspace documented thoroughly? Run your domain through this linter to see where you can improve.

⚠️ Note: if you recently published or updated the workspace, the results may not be accurate because the rendered HTML is cached and updated every 7 days.

Read the blog post: [Design Your Own Style Guide with This Public Workspace Linter]

Watch the video walkthrough: Workspace Linter Using a Style Guide

Get Started

Step 1: Update the collection variable domain with your own team's domain.

• Select the collection in the left sidebar, and tab over to Variables. Find the key called domain, and input your domain under Current and Initial values.
• Example: The URL for Stripe's team profile page is Stripe team's domain on Qodex isstripedev`

Step 2: Run the collection to initialize the configuration and check the completeness of your public workspace(s).

• Select the collection in the left side, and then select the Run collection option.
• Inspect the test results to see how high you scored and areas for improvement.

Additional Resources

• [How to Set Up Your First Public Workspace in 5 Easy Steps]
• [Introducing The Good Documentation Checklist]
• [Increasing Adoption of an API with a Public Workspace]

Examples of Great Workspaces

• [Mercedes-Benz automotive]
• [Belvo open banking API for Latin America]
• [ArcGIS Location Services]

1. Configuration setup (workspaces)

GET https://www.postman.com/{{domain}}?tab=workspaces

---

2. API checker

GET {{apiUrl}}

---

3. Configuration setup (collections)

GET https://www.postman.com/{{domain}}?tab=collections

---

4. Team profile checker

GET https://www.postman.com/{{domain}}?tab=apis

---

5. Workspace checker

GET {{workspaceUrl}}

---

6. Collection checker

GET {{collectionUrl}}

---

7. Total Score

GET https://www.postman.com/{{domain}}

---