Boost API Testing: How to Integrate Swagger with Postman for Seamless Debugging

When using Swagger, you may feel frustrated because JSON request parameters cannot be formatted, errors are hard to locate, response results cannot be collapsed, and long outputs are difficult to read.

Postman Usage

Postman is a powerful API debugging tool with a beautiful interface; you can read the introductory article "Postman: API Debugging Tool" for more details.

Using Swagger with Postman

Below we introduce how to import Swagger APIs into Postman and then use Postman to debug the interfaces.

Import Swagger API into Postman

Start the application that uses Swagger, e.g., the mall-tiny-swagger project, and locate the api-docs path. Access it at http://localhost:8088/swagger-ui/ .

The api-docs endpoint returns JSON data; Swagger renders the API documentation from this data. The JSON can also be accessed at http://localhost:8088/v2/api-docs .

In Postman, click the import button, choose Link , and enter the Swagger api-docs URL to import the APIs.

Use the default import options; no modifications are needed.

After a successful import, the Swagger interfaces appear in Postman, and you can modify parameters to start debugging.

Set Environment Variables in Postman

If an interface returns an error, the baseUrl environment variable may be misconfigured.

Set the baseUrl variable in Postman to the correct value to access the API normally.

After adding the variable, select the appropriate environment so it takes effect.

Access Endpoints Requiring Authentication

When an endpoint requires login, first call the login API to obtain a token.

Add a Bearer Token to the request header; this requires a token environment variable.

Define the token variable in the environment and assign the obtained token value.

After setting the variable, the authenticated endpoint can be accessed successfully.

Drawbacks

Using Postman for debugging is powerful, but its documentation display capability is weaker.

Swagger provides comprehensive annotations for request and response parameters.

Postman does not show these documentation details because it is primarily a debugging tool.

Conclusion

Combining Swagger and Postman works well: use Swagger for detailed API documentation and Postman for debugging; importing Swagger APIs into Postman compensates for Swagger's debugging shortcomings.

Project Source Code

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-swagger