preface
Interface documentation is very important in development, especially now that web development is beginning to separate the front and back ends, a good interface documentation is needed.
How do you quickly export interface documents, call examples, and mocks? If it’s too much trouble, a lot of people won’t write about it.
Today I will introduce a very convenient tool, easydoc.xyz
Yiwen file is a professional interface management platform, it can easily write professional beautiful API documents, more importantly, it can generate interface documents, call examples, mock configuration, at one stroke 30%, easy and happy.
Get a sneak peek and see the preview online
How do you make it with one key
After developing an interface, we usually need to do an interface test to make sure that the interface is OK
It provides online interface testing. The key is that after testing, it can generate interface documentation with one click based on your request and response parameters, which in turn can generate mock configurations with one click, and save the entire test process as a sample invocation.
Now that the interface is tested, you have your documentation, samples, and mocks.
GIF demonstrates one-click document generation
Gifs demonstrate generating invocation examples
Adding invocation examples gives others a better understanding of how to invoke the interface.
You can save the entire request and response parameters as a sample invocation after the interface test
Call sample can also facilitate the test personnel to save a variety of test results oh, such as mobile phone number login, verification code login and other different calls, different critical values can be saved as a call example
One-click generation of mock configurations
The server interface is not developed, how to do? Once the interface is documented, the mock configuration can be generated with one click and the client is ready to develop, as shown below
Final document effect
Below is the final document preview, with the green crawler representing the invocation sample and the bottle representing the mock, viewed online
