Author: Phantom
Introduction
For front-end and back-end developers and test engineers, it is often necessary to debug or test the developed API interface, because some interfaces may be troublesome and inefficient to directly trigger in the system page or scene. Therefore, API debugging tools such as PostMan are often used to help us debug and detect whether the interface meets the development requirements.
However, PostMan is more used in the interface testing of back-end personnel. For some scenarios such as: the front-end needs Mock data debugging pages, API designers need to design API documents, testers need to stress test and other scenarios, it cannot fully satisfy . Therefore, in order to meet the needs in the above development scenarios and make the overall efficiency of the development team higher, so that developers can avoid the torture of overtime, the domestic API debugging artifact was born - ApiPost .
This article mainly introduces the features and highlights of ApiPost. Whether you are developing a test or a product, I hope the tools introduced in this article can be helpful for future development work.
Introduction to ApiPost
ApiPost is an integrated collaboration platform for API documentation , debugging , mocking , and testing that supports simulating common HTTP requests such as POST, GET, and PUT, supports team collaboration, and can directly generate and export interface documents.
The interface layout of ApiPost is somewhat similar to that of PostMan. If you have used PostMan before, and its design conforms to domestic development and usage habits, you will get started quickly.
Official website experience: https://www.apipost.cn/
Features and Highlights
- For back-end developers, interface documentation can be directly generated in the project where interface debugging has been completed, and there is no need to repeatedly manually write interface documentation.
- For front-end developers, they can directly test through documents when developing joint debugging with back-end engineers, and they can also develop and connect in advance through Mock data.
- For API designers, Mock can be designed in advance to specify the interface specification, so that when the back-end database has not been built and the API code has not yet been written, the front-end can still enter the R&D process in advance.
- For testers, they can participate in the whole process of the interface from the specified specification to the interface test through cooperation, reducing the communication cost and improving the test efficiency.
- Integrate Swagger interface document function, PostMan debugging interface function, PAP data Mock function, JMeter automated interface testing function.
One tool = Postman (interface debugging) + swagger (interface documentation) + Mock (Mock service) + process testing
In fact, in the whole process of requirement development, communication and coordination sometimes takes more time than development time. By reducing these time costs, the efficiency of development work can be greatly improved.
As mentioned above, ApIPost can realize the whole process of project landing through unified and standardized collaboration, which can greatly improve efficiency.
Use of highlights
Take Hengyoushu-1.1.1 stock list API interface debugging as an example to explain the use of the highlight function.
API interface debugging
First, configure the platform interface verification Token into the global parameter, so that the parameter can be automatically added to the newly created interface without repeating the configuration. Then fill in the interface link and request parameters, and when a request occurs, the interface data can be obtained and printed on the console below.
Quick generation of API interface documentation
After the interface debugging is completed, the interface document can be generated with one click by sharing the document or sharing the project . Then through the document link, you can achieve document access and sharing.
Mock Data Service
In scenarios that require agile development, all project developers are required to develop projects simultaneously. For front-end developers, if they need to develop in advance, they must simulate the back-end interface to request data. The above functions are implemented through the Mock service provided by APIPOST.
First create an interface, select the Mock service, then customize a request URL suffix /test_stock_list, and fill in the parameters to be returned.
Finally, copy the link and send the request to get the simulated response data. Isn't it very convenient?
Automated interface testing
For development engineers, ApiPost can perform interface collection testing according to the specified environment, and can perform automated testing by configuring the testing process.
Summarize
As a domestic development tool, ApiPost understands the pain points of domestic development teams. This tool is more in line with the habits of domestic users. If it is used in the project development process, it can greatly improve work efficiency and save development costs.
From personal experience, although ApiPost may still have some details that are not so perfect, its development team can listen to the voice of users, and the project is continuously investing in research and development, I believe it can do better and better. Interested students can also download the experience. (The picture below shows the voice of the ApiPost team)
