App Backend development Ii: API Interface documentation Tools

Source: Internet
Author: User
<span id="Label3"></p><strong><strong>A history of sadness</strong></strong><p><p>In the app backend development process, The backend will provide a lot of API interface for the front-end development and use, in order to let front-end developers to use, we will write a document to tell them that the interface you should use <code>GET</code> or <code>POST</code> to access, while the access time to pass me some parameters, As well as the right time I will return what to you, the data styles that have been returned and the field explanations and so on these things, we all need to write clearly in the Document.</p></p><p><p>Develop one on app Backend: build API interface documentation tools based on Swagger-ui this blog, I wrote <code>swagger-ui</code> the benefits and Advantages. But in the use of the process, found insufficient to Force. What I want to achieve is that the code is finished, and the API interface document is written Out. No time-consuming and laborious alone to maintain it. So today I decided to let you know if you are using LARAVEL5 to generate API interface Documentation.</p></p><p><p>PS: If you do <strong> <code>Laravel5</code> </strong> not know enough, You can click here to View.</p></p><strong><strong>Usage Scenarios</strong></strong><p><p>This is <code>Laravel5</code> a plugin that I automatically generate based on an API document that I Developed. It is the front-end use of the Swagger-ui (or the use of my own modified Chinese version), the back end of the use of swagger-php. After installing the plugin via composer, as long as you write the model and controller to write a note, your API document will be accessed automatically when the comments, to generate the API document interface in Real-time.</p></p><p><p>Effect:<br><br>This shows the operations provided by each Module.</p></p><p><p><br>Click the test button, you can directly operate, where the front end of the introduction and I wrote the first document is Always.</p></p><p><p>The main increase here is that the backend section is automatically generated, and the front end has no changes.</p></p><strong><strong>Get this plugin</strong></strong><p><p>Specifically how to install the inheritance into the project, see here<br>Project Address: GitHub Project address<br><em>Note: This project can only be used for Laravel5, and can only be installed using Composer.</em></p></p><p><p>If you feel helpful, or can provide help to improve the project together, welcome <code>Star</code> with <code>Pull requests</code> !</p></p> <p style="font-size:12px;"><p style="font-size:12px;">Copyright Notice: This article for Bo Master original article, without Bo Master permission not Reproduced.</p></p> <p><p>App Backend development Ii: API Interface documentation Tools</p></p></span>

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.