Table of contents
1.
Introduction📖
2.
Using Custom Domains👨🏻‍💻
2.1.
Adding a Custom Domain➕
2.2.
Verifying Your Domain🔎
2.3.
Adding DNS Records🗃️
2.4.
Troubleshooting DNS Issues✔
3.
Publishing a Collection on Your Custom Domain👩🏻‍💻
4.
Frequently Asked Questions
4.1.
What is a postman?
4.2.
What is the purpose of using postman?
4.3.
What are postman's limitations?
4.4.
Explain postman as a testing tool.
4.5.
Why is postman the best API testing tool?
5.
Conclusion
Last Updated: Mar 27, 2024

Using Custom Domain For the API Documentation in Postman

Career growth poll
Do you think IIT Guwahati certified course can help you in your career?

Introduction📖

Postman is an API client that allows developers to quickly create, share, test, and document APIs. This is accomplished by allowing users to create, save, and read simple and complex HTTP/s requests.

Using Custom Domain For the API Documentation in Postman coding ninjas

In this article, we will discuss using a custom domain for the API documentation in postman.

Using Custom Domains👨🏻‍💻

Postman provides the functionality of using a custom domain for your API documentation. We will discuss using custom domains under the following headings:

Adding a Custom Domain➕

To add a custom domain, open the postman web dashboard and navigate to the team tab.

adding a custom domain postman coding ninjas

Now navigate to the custom domains section, which displays a list of domains and their verification status. Choose to add custom domain.

custom domains postman coding ninjas

In the following step, enter the domain URL you want to add. Your domain can be either a whole domain or a subdomain. You can, for example, use either example.com or api.example.com.

add custom domain postman coding ninjas

Now to verify your domain, click proceed.

Verifying Your Domain🔎

Postman displays the DNS records required to verify domain ownership when you add a custom domain. To prove that you own the domain you're attempting to add, add the provided tokens as TXT and CNAME DNS records to your domain.

Verifying Your Domain postman coding ninjas

Adding DNS Records🗃️

Verify the ownership of DNS records with a DNS web service provider. Go to the DNS provider's console in a separate browser tab and add the two new records listed below.

  1. A TXT record for postman-echo.com verifies domain ownership. The value must match the token displayed in the modal. Incorporate the TXT record into the root domain. If you're adding example.com or api.example.com, add the TXT record to example.com.
  2. As shown in the modal, a CNAME record for docs.postman-echo.com. This value is required to be phs.getpostman.com. Include the CNAME record in the URL for your public documentation.

To verify the domain, select confirm domain. After checking, I've added the TXT and CNAME records checkbox. The domain will be verified when you receive a confirmation message.

Adding DNS Records postman coding ninjas

Note: To host public documentation on your domain, postman employs letsencrypt as an SSL certificate provider to host public documentation on your domain. If your domain lacks CAA records, letsencrypt will generate a certificate automatically. LetsEncrypt requires an explicit CAA record to issue a certificate for a domain with CAA records. Refer to the letsencrypt documentation to enable letsencrypt to issue this certificate.

You can select verify later if you do not want to verify the domain right now. By selecting delete custom domain, you can delete the custom domain. It may take up to 24 hours for your DNS settings to take effect.

Troubleshooting DNS Issues✔

Troubleshooting DNS Issues postman coding ninjas

If you receive the error message when adding your first domain, remember that CNAME records cannot coexist with any other domain records. You must either change the existing record type for your subdomain to CNAME or create a new subdomain.

If you receive the same message when adding your second domain, remember that because the TXT record verifies domain ownership, the value will be the same as the token you said for the root domain. Include the CNAME record in the URL associated with your public documentation, with the value phs.getpostman.com.

Publishing a Collection on Your Custom Domain👩🏻‍💻

You can use your domain to publish your API documentation once it has been verified. If you already have a collection published, you can update it to use the new domain.

Publishing a Collection on Your Custom Domain postman coding ninjas

Frequently Asked Questions

What is a postman?

Postman is an API client that allows developers to quickly create, share, test, and document APIs. This is accomplished by allowing users to create, save, and read simple and complex HTTP/s requests.

What is the purpose of using postman?

Developers can easily create, share, test, and document APIs with the postman, an API client. Users are given the ability to generate, store, and read both simple and complicated HTTP/s requests as well as their responses to achieve this.

What are postman's limitations?

Postman monitors cannot handle global variables. We must copy all of the global variables as local variables within a newly created environment when creating a Monitor. The free version of the postman monitor can only assist us in becoming acquainted with its features.

Explain postman as a testing tool.

An extensive API testing tool that postman provides makes it simple to put up automated tests. The tests and requests you have made can be combined into a single automatic test sequence.

Why is postman the best API testing tool?

Postman is a graphical user interface-based application that allows us to test APIs. postman's benefits include the collection feature and the ability to create multiple testing environments. A postman is a simple tool that helps us save time when running tests.

Conclusion

This article extensively discussed using a custom domain for the API documentation in postman. 

Do you not feel eager to read/explore additional information on the subject of postman after reading about using a custom domain for the API documentation in postman? See the Introduction to Postmanpostman for API testingUsing the Collection Runner and scheduling runs with monitors in postman, and How to Manage and Share an API in Postman?

Refer to our guided paths on Coding Ninjas Studio to learn more about DSA, Competitive Programming, JavaScript, System Design, etc. Enrol in our courses and refer to the mock test and problems available. Take a look at the interview experiences and interview bundle for placement preparations.

Happy Learning Ninja! 🥷

Live masterclass