{"repo":"YeDaxia/JApiDocs","free":true,"listed":false,"github":"https://github.com/YeDaxia/JApiDocs","clone":"git clone https://github.com/YeDaxia/JApiDocs.git","description":"A magical api documentation generator without annotation for springboot.","language":"Java","stars":1695,"topics":["api","apidocs","springboot","api-documentation"],"license":"Apache-2.0","category":"api-integrations-sdks","readme_excerpt":"Getting Started Supported JDK：1.8+ Quick Start Step One：Add Dependency maven: gradle: Step Two：Configuration You can run code below at any main(): If there is no accident, after executing the above code, you can see the generated documents in the configured directory. Code Style Requirements JApiDocs is implemented by parsing Java source code. To make JApiDocs work correctly, you need to follow certain coding standards in the writing of Controller in the project. You can refer the SpringDemo module in the source code for comparison and understanding. 1. Add Necessary Code Comments The class comment will correspond to the first-level grouping. You can also specify the group name through @description ; JApiDocs will use @param to find parameters for further analyze. If the submitted form is application/x-www-form-urlencoded type, you can add a description after @param or add an comment in JavaBean object : This form type would show as table in the document： parameter name parameter type must description -- -- -- -- status int N user status name string N user name If the submitted form is application/json type, corresponding to the @RequestBody annotation in SpringBoot, it will display as json format in the document: 2. Return Specific Class Type We know that if a Controller Class declares @RestController, SpringBoot will return json data to the front end. JApiDocs also uses this feature to parse the result in the api method, but since JApiDocs parses the source code statically,","default_branch":null,"files":null,"tree":[],"storefront":"/r/YeDaxia","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/YeDaxia/JApiDocs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}