Apifox: saving every minute of the R & D team

Blog home page ： Blog without hair loss

Wonderful summary ：Apifox  yes API file 、API debugging 、API Mock、API Automated testing integrated collaboration platform , location  Postman + Swagger + Mock + JMeter.API Documentation and API Development and debugging use the same tool ,API After debugging, you can Guarantee and API The document definition is exactly the same . Efficient 、 In time 、 accuracy ！

If you think the article is good, you are welcome to praise Collection ️ Comments support bloggers

---

Catalog

Apifox： Save every minute of the R & D team

1️⃣ reveal Apifox

What is? Apifox？

Why use Apifox？

Apifox The function or characteristic of ？

Where can I use it Apifox？

Who is in use Apifox？

2️⃣Apifox Quick start

download

install

---

Apifox： Save every minute of the R & D team

---

1️⃣ reveal Apifox

What is? Apifox？

Official website ：http://www.apifox.cn

Apifox  yes API file 、API debugging 、API Mock、API Automated testing integrated collaboration platform ,

location ： Apifox = Postman + Swagger + Mock + JMeter.

Purpose ： Save every minute of the R & D team

---

Why use Apifox？

Pain points of the development team ：

With the Internet of things 、 Micro service and DevOps And so on , Of each team API The quantity demand is growing explosively . In the collaboration of the entire development team , A lot of work revolves around API Conduct . However, in the existing workflow , quite a lot API Collaborative work is scattered among many tools that are not used , Include Postman、Swagger、Mock and JMeter etc. . For tips API Development efficiency , And protect API The biggest obstacle to quality is the lack of appropriate technology and tools . Problems often encountered in the development process 、 Back end and testing Team about API The synergy of is inefficient .

Common solutions ：

The problem is ：

• It's very difficult to maintain data consistency between different tools 、 Inefficient . And it's not just about the workload , The bigger problem is data inconsistency between multiple systems , Leading to inefficient collaboration 、 Frequent problems , Developers and testers are in agony .

• Developers in Swagger After defining the document , Interface debugging also needs to go Postman Define it again .

• The front-end development Mock When it comes to data mockjs Define it again , You also need to set it manually Mock The rules .

• Testers need to go to JMeter Define it again .

• Front end according to mockjs Mock The data is developed , Back end according to Swagger The defined interface document is developed , They all passed the test , I thought I could go online right away , As a result, a variety of problems were found ：

  • The interface changed during development , Only modified Swagger, But they didn't synchronize the changes in time mockjs.
  • The interface data type of back-end development is inconsistent with the document , It's hard to see the problem with the naked eye .
• Again , Test in JMeter Well written test cases , When it's really running, you'll find all kinds of inconsistencies .
• Time is long. , The inconsistencies will get more and more serious .

Use Apifox：Postman + Swagger + Mock + JMeter

Through a system 、 A piece of data , Solve the problem of data synchronization between multiple systems . Just define API file ,API debugging 、API data Mock、API Automated testing can be used directly , There is no need to redefine ;API Documentation and API Development and debugging use the same tool ,API After the commissioning, it can be guaranteed and API The document definition is exactly the same . Efficient 、 In time 、 accuracy ！

Apifox The function or characteristic of ？

• Interface design ：Apifox Interface documentation follows  OpenApi 3.0 ( primary Swagger)、JSON Schema  At the same time , It's very easy to use visualization Document management function , Zero learning cost , Very efficient . And support online sharing of interface documents .
• Data model ： Reusable data structure , Defining interfaces Return data structure And Request parameter data structure （ only JSON and XML Pattern ） You can directly reference . Support model direct nested reference , direct JSON/XML Smart import , Support oneOf、allOf And other advanced combination modes .
• Interface debugging ：Postman Some functions , For example, environment variables 、 In front of / Post script 、Cookie/Session Global Shared And so on ,Apifox There are , And ratio Postman More efficient and easy to use . After the interface runs, click Save as use case Button , It can generate Interface use cases , Interface use cases can be run directly later , No more parameters need to be entered , Very convenient . Custom script 100% compatible Postman grammar , And support running javascript、java、python、php、js、BeanShell、go、shell、ruby、lua And other language codes .
• Interface use cases ： Usually, an interface has multiple use cases , such as The parameters are correct Use cases 、 Parameter error Use cases 、 Data is empty Use cases 、 Different data states Use cases, etc . The correctness of data will be automatically verified when running the interface case , Using interface use cases to debug interfaces is very efficient .
• Interface data Mock： built-in  Mock.js  Rules engine , Very convenient mock All kinds of data , And you can define the data structure and write mock The rules . Support adding “ expect ”, According to the request parameters, different mock data . most important of all Apifox  Zero configuration   that will do Mock Very human data , The details are introduced later in this paper .
• Database operation ： Support reading database data , Used as an interface request parameter . Support reading database data , Used to verify ( Assertion ) Whether the interface request is successful .
• Interface automation testing ： Provide interface set testing , You can choose the interface （ Or interface use cases ） Quickly create test sets . At present, more functions of interface automation test are still under development , Coming soon ！ The goal is ： JMeter Some functions are basically , And use it better .
• Quick request ： similar Postman Interface debugging mode , It is mainly used for temporary debugging No documentation required The interface of , You can quickly debug without defining the interface in advance .
• Code generation ： Define according to the interface and data model , Automatic system generation Interface request code 、 Front end business code And Back end business code .
• Teamwork ：Apifox Born for teamwork , Interface cloud real-time synchronous update , ripe The team / project / Member rights management , Meet the needs of various enterprises .

Where can I use it Apifox？

Best practices

1. front end （ Or back end ）： stay Apifox Finalize the first draft of the interface document .
2. Front and rear ends ： Review together 、 Improve interface documents , Define interface use cases .
3. front end ： Use the interface automatically generated by the system according to the interface document Mock Data into development , No handwriting required mock The rules .
4. Back end ： Use interface use cases Debug the interface in development , As long as all interface use cases are debugged , The interface development is completed . If the interface changes during development , transfer The document is automatically updated when trying , Zero cost ensures the timeliness of interface maintenance .
5. Back end ： Each time a function is debugged, it is saved as an interface use case .
6. Testers ： Test interfaces directly using interface use cases .
7. After all interfaces are developed , Testers （ It can also be the back end ） Use the set test function to carry out multi interface integration test , Test the whole interface call flow completely cheng .
8. Both front and rear ends have been developed , Front end from Mock Data switching to official data , Joint commissioning usually goes very smoothly , Because both the front end and the back end fully comply with the interface requirements The norm of righteousness .

Who is in use Apifox？

2️⃣Apifox Quick start

download

Download url , You can order it here  Apifox , Support Windows（64 position ）、Windows（32 position ）、MacOS（Intel chip ）、MacOS（M1 chip ）、Linux（.Applmage）、Linux（.tar.gz）.

You can also use Web The client version uses （ If you need to import a document , It is recommended to use the client ）

install

Follow the instructions of the installation package .

register

Recommended WeChat Sweep the login code , If there is no account, an account will be created , Just scan the code to complete , In the future, you only need to scan the wechat code to log in .

It also supports email registration .

Create a team

After successful login , Display as a team page . We will provide you with a Sample team Medium The sample project , You can click to enter , Learn and explore the software

You can also create your own team , Here's the picture

You can also ask your team members to invite you to an existing team , When accepting an invitation , You can click on the top right corner small bell Operation

For team management, you can view   Team management

Create project

Here's the picture , You can click on the New projects , Create new projects

Entry project

Here we use New projects For reference , You can 《 A minute , understand Apifox！》 Understand the general content , You can also click 《20 Minutes to learn Apifox》 Watch Video

Import data

Details can be found in   Import data

Derived data

Details can be found in   Derived data

An overview of the interface

Interface design

Details can be found in   Interface design

Interface operation

More detailed instructions for each module , Please have a look at   Help center