1 Star 0 Fork 115

nicxsky / JApiDocs

forked from mallkiller / JApiDocs 
Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
This repository doesn't specify license. Without author's permission, this code is only for learning and cannot be used for other purposes.
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README-EN.md

Introduction

Click hear to check the example.

JApiDocs is a Java programming tool that complies with the Java programming conventions. JApiDocs will help you to export a beautiful Html document and generate relevant Java and Object-C related data model code, this will reduce Android And IOS Client Developers's work, and you do not need to work hard to maintain changes in the api documents, just need to maintain your code.

Features

  1. A Controller as a set of api export to a html file.
  2. Support Java And Object-C Model Code generation.
  3. Depth support Spring Boot, Play Framework, JFinal, no need to declare additional routing.
  4. Support the general Java Web project, need to add additional routing in the relevant annotation.
  5. Support interface statement outdated (@Deprecated), convenient document directory and so on.
  6. Support for custom code generation templates.

Quick Start

  1. In spring, for example, the image below will help you easilly to understand how JApidocs works. As you can see, you can done your work so naturally. the only extra part is the @ApiDoc, we will discuss this below.

  2. @ApiDoc is a custom annatation, as we known, unless we run the program , otherwise we can not know what the response really contains. To solve this problem, we bring into View Class, we can know what will return in the response by the View Class, and JApiDocs will read every member of it and its parent class except the static member. this is why @ApiDoc exists.

you can just simplly include our jar or create a class naming ApiDoc in your project, it doesn't care where package it belongs.

@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.METHOD})
public @interface ApiDoc {

    /**
     * result class
     * @return
     */
	Class<?> value() default Null.class;

    /**
     * result class
     */
	Class<?> result() default Null.class;

    /**
     * request url
     */
	String url() default "";

    /**
     * request method
     */
	String method() default "get";

    final class Null{

    }
}
  1. run to generate docs

command line mode

(1) download the jar end with all. (2) create a file name docs.config, the properties contains:

projectPath = your project root path(required)
docsPath = the output docs path(not required,defualt ${projectPath}/apidocs)
codeTplPath = the custom code template path (not required)
mvcFramework = [spring, play, jfinal, generic](not required,JApiDocs will try to find which framework you are using, but sometimes it may not work, so you can set this to let it know).

java code mode

(1) add dependencies below:

compile 'io.github.yedaxia:japidocs:1.2'

(2) one line simple java code:

Docs.buildHtmlDocs(DocsConfig config);
  1. custom java or object-c code:

copy the template files in the project, and make the template you like:

Notes

  1. not support cycle class:
class UserVO{
    BookVO book;
}

class BookKVO{
    UserVO user;
}
  1. Jfinal Users should put the routes in the method configRoute:
@Override
public void configRoute(Routes me) {
    me.add("/api/v1/user", UserController.class);
    me.add("/api/v1/book", BookController.class);
    me.add(new AmdinRoutes());
}

License

JApiDocs is available under the Apache 2 License. Please see the Licensing section for more information.

Comments ( 0 )

Sign in for post a comment

About

一个 Java 程序员用的高效 API 文档生成工具。 spread retract
Java
Cancel

Releases

No release

Contributors

All

Activities

load more
can not load any more
Java
1
https://gitee.com/nicxsky/JApiDocs.git
git@gitee.com:nicxsky/JApiDocs.git
nicxsky
JApiDocs
JApiDocs
master

Search