[tool] apifox

Preface

Apifox yes API file 、API debugging 、API Mock、API Automated testing integrated collaboration platform , location 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

Best practices

• front end （ Or back end ） stay Apifox Finalize the first draft of the interface document .
• Front and rear ends Review together 、 Improve interface documents , Define interface use cases .
• 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 .
• Back end Use interface use cases to debug interfaces in development , As long as all interface use cases are debugged , The interface development is completed . If the interface changes during development , When debugging, the document is automatically updated , Zero cost ensures the timeliness of interface maintenance .
• Back end Each time a function is debugged, it is saved as an interface use case .
• Testers Test interfaces directly using interface use cases .
• 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 , Completely test the whole interface call process .
• Front and rear ends All developed , Front end from Mock Data switching to official data , Joint commissioning usually goes very smoothly , Because both the front and back sides fully comply with the specification of the interface definition .

Basic concepts

• Interface design ： Define interface specifications （ Such as interface path 、 Parameters 、 Return value 、 Data structure, etc ）, That is to write interface documents .
• Interface operation ： Enter specific interface parameters , And then run , It is mainly used to debug the interface . After the interface runs, click the save as use case button , Interface use cases can be generated , Interface use cases can be run directly later , No more parameters need to be entered , Very convenient .
• Interface use cases ： Usually, an interface has multiple use cases , For example, the parameters are correct, and the use case 、 Parameter error use case 、 Data is empty use case 、 Different data state 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 .
• Data model ： Reusable data structure , Define the interface return data structure and request parameter data structure （ only JSON and XML Pattern ） You can directly reference .
• Set test ： Multi interface integration test , There are mainly functional tests 、 Performance testing 、 Contrast test .
• Quick request ： similar Postman Interface debugging mode , The main purpose is to temporarily debug some interfaces that do not need to be documented , You can quickly debug without defining the interface in advance .
• Code generation ： Define according to the interface and data model , The system automatically generates the interface request code 、 Front end business code and back-end business code .

Interface Overview

Apifox and Apipost Choose to see this

Apifox and Apipost What's the difference? ？ Who is better ？

Official documents

Apifox Using document