provideFields(ClassNode respNode);
16 | }
17 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/exception/JavaFileNotFoundException.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.exception;
2 |
3 | /**
4 | * java file not found exception
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | public class JavaFileNotFoundException extends RuntimeException {
9 |
10 | public JavaFileNotFoundException() {
11 | }
12 |
13 | public JavaFileNotFoundException(String message) {
14 | super(message);
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/resources/Code_File.html.tpl:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 | ${FILE_NAME}
6 |
7 |
8 |
9 |
10 | ${MODEL_LIST}
11 |
12 |
13 |
--------------------------------------------------------------------------------
/doc-apis-test/src/test/java/com/docapis/test/TestApplication.java:
--------------------------------------------------------------------------------
1 | package com.docapis.test;
2 |
3 | import org.springframework.boot.SpringApplication;
4 | import org.springframework.boot.autoconfigure.SpringBootApplication;
5 |
6 | /**
7 | * 启动类
8 | *
9 | * Copyright © 2024 xpc1024 All Rights Reserved
10 | **/
11 | @SpringBootApplication
12 | public class TestApplication {
13 | public static void main(String[] args) {
14 | SpringApplication.run(TestApplication.class, args);
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/DocIgnore.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core;
2 |
3 | import java.lang.annotation.ElementType;
4 | import java.lang.annotation.Retention;
5 | import java.lang.annotation.RetentionPolicy;
6 | import java.lang.annotation.Target;
7 |
8 | /**
9 | * DocIgnore annotation
10 | *
11 | * licence Apache 2.0, from japidoc
12 | **/
13 | @Retention(RetentionPolicy.SOURCE)
14 | @Target({ElementType.FIELD, ElementType.TYPE, ElementType.METHOD})
15 | public @interface DocIgnore {
16 | }
17 |
--------------------------------------------------------------------------------
/doc-apis-test/src/main/java/com/docapis/test/DocPlusApplication.java:
--------------------------------------------------------------------------------
1 | package com.docapis.test;
2 |
3 | import org.springframework.boot.SpringApplication;
4 | import org.springframework.boot.autoconfigure.SpringBootApplication;
5 |
6 | /**
7 | * 启动类
8 | *
9 | * Copyright © 2024 xpc1024 All Rights Reserved
10 | **/
11 | @SpringBootApplication
12 | public class DocPlusApplication {
13 | public static void main(String[] args) {
14 | SpringApplication.run(DocPlusApplication.class, args);
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/RapMock.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core;
2 |
3 | import java.lang.annotation.ElementType;
4 | import java.lang.annotation.Retention;
5 | import java.lang.annotation.RetentionPolicy;
6 | import java.lang.annotation.Target;
7 |
8 | /**
9 | * RapMock annotation
10 | *
11 | * licence Apache 2.0, from japidoc
12 | **/
13 | @Retention(RetentionPolicy.SOURCE)
14 | @Target({ElementType.FIELD})
15 | public @interface RapMock {
16 |
17 | String limit() default "";
18 |
19 | String value() default "";
20 | }
21 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/ios/ModelTemplateProvider.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.ios;
2 |
3 |
4 | import com.docapis.core.codegenerator.TemplateProvider;
5 |
6 | import java.io.IOException;
7 |
8 | /**
9 | * 模型目标构造
10 | *
11 | * licence Apache 2.0, from japidoc
12 | **/
13 | public class ModelTemplateProvider {
14 |
15 | public String provideTemplateForName(String templateName) throws IOException {
16 | return TemplateProvider.provideTemplateForName(templateName);
17 | }
18 |
19 | }
20 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/TemplateProvider.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator;
2 |
3 |
4 | import com.docapis.core.Resources;
5 | import com.docapis.core.Utils;
6 |
7 | import java.io.IOException;
8 |
9 | /**
10 | * template provider
11 | *
12 | * licence Apache 2.0, from japidoc
13 | **/
14 | public class TemplateProvider {
15 | public static String provideTemplateForName(String templateName) throws IOException {
16 | return Utils.streamToString(Resources.getCodeTemplateFile(templateName));
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/java/JavaTemplateProvider.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.java;
2 |
3 |
4 | import com.docapis.core.codegenerator.TemplateProvider;
5 |
6 | import java.io.IOException;
7 |
8 | /**
9 | * java template provider
10 | *
11 | * licence Apache 2.0, from japidoc
12 | **/
13 | public class JavaTemplateProvider {
14 |
15 | public String provideTemplateForName(String templateName) throws IOException {
16 | return TemplateProvider.provideTemplateForName(templateName);
17 | }
18 |
19 | }
20 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/MockNode.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | /**
4 | * mock node
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | public class MockNode {
9 |
10 | private String limit;
11 | private String value;
12 |
13 | public String getLimit() {
14 | return limit;
15 | }
16 |
17 | public void setLimit(String limit) {
18 | this.limit = limit;
19 | }
20 |
21 | public String getValue() {
22 | return value;
23 | }
24 |
25 | public void setValue(String value) {
26 | this.value = value;
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/plugin/rap/DeleteActionFrom.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.plugin.rap;
2 |
3 | /**
4 | * delete action from
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | class DeleteActionFrom {
9 |
10 | private String className;
11 | private Integer id;
12 |
13 | public String getClassName() {
14 | return className;
15 | }
16 |
17 | public void setClassName(String className) {
18 | this.className = className;
19 | }
20 |
21 | public Integer getId() {
22 | return id;
23 | }
24 |
25 | public void setId(Integer id) {
26 | this.id = id;
27 | }
28 | }
29 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/I18n.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core;
2 |
3 | import java.util.Locale;
4 | import java.util.ResourceBundle;
5 |
6 | /**
7 | * i18n
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | public class I18n {
12 |
13 | private ResourceBundle resourceBundle;
14 |
15 | public I18n() {
16 | this.resourceBundle = ResourceBundle.getBundle("message", Locale.getDefault());
17 | }
18 |
19 | public I18n(Locale locale) {
20 | this.resourceBundle = ResourceBundle.getBundle("message", locale);
21 | }
22 |
23 | public String getMessage(String name) {
24 | return resourceBundle.getString(name);
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/doc/Link.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.doc;
2 |
3 | /**
4 | * link
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | class Link {
9 | private String name;
10 | private String url;
11 |
12 | public Link(String name, String url) {
13 | this.name = name;
14 | this.url = url;
15 | }
16 |
17 | public String getName() {
18 | return name;
19 | }
20 |
21 | public void setName(String name) {
22 | this.name = name;
23 | }
24 |
25 | public String getUrl() {
26 | return url;
27 | }
28 |
29 | public void setUrl(String url) {
30 | this.url = url;
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/resources/css/prettify.min.css:
--------------------------------------------------------------------------------
1 | .pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}
--------------------------------------------------------------------------------
/doc-apis-core/src/main/resources/message.properties:
--------------------------------------------------------------------------------
1 | catalog=catalog
2 | requestUrl=request url
3 | requestParameters=request parameter
4 | requestBody=request body
5 | parameterName=parameter name
6 | parameterType=parameter type
7 | parameterNeed=must
8 | description=description
9 | responseResult=response
10 | searchPlaceholder=search api
11 | deprecated=deprecated
12 | yes=Y
13 | no=N
14 | doc.generate.tip=This documentation is generated by doc-apis
15 | author=author
16 | new=New
17 | modify=Modify
18 | currentVersion=current version
19 | lastVersion=last version
20 | classificationLevel=classification level
21 | adv=Sponsorship advertising space cooperation Mail: xpc@dromara.org
22 | advLink=https://en.doc-apis.com/pages/top888/
--------------------------------------------------------------------------------
/doc-apis-core/src/main/resources/message_en.properties:
--------------------------------------------------------------------------------
1 | catalog=catalog
2 | requestUrl=request url
3 | requestParameters=request parameter
4 | requestBody=request body
5 | parameterName=parameter name
6 | parameterType=parameter type
7 | parameterNeed=must
8 | description=description
9 | responseResult=response
10 | searchPlaceholder=search api
11 | deprecated=deprecated
12 | yes=Y
13 | no=N
14 | doc.generate.tip=This documentation is generated by doc-apis
15 | author=author
16 | new=New
17 | modify=Modify
18 | currentVersion=current version
19 | lastVersion=last version
20 | classificationLevel=classification level
21 | adv=Sponsorship advertising space cooperation Mail: xpc@dromara.org
22 | advLink=https://en.doc-apis.com/pages/top888/
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/DocApi.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core;
2 |
3 | import java.lang.annotation.ElementType;
4 | import java.lang.annotation.Retention;
5 | import java.lang.annotation.RetentionPolicy;
6 | import java.lang.annotation.Target;
7 |
8 | /**
9 | * DocApi annotation
10 | *
11 | * licence Apache 2.0, from japidoc
12 | **/
13 | @Retention(RetentionPolicy.SOURCE)
14 | @Target({ElementType.TYPE, ElementType.METHOD})
15 | public @interface DocApi {
16 |
17 | Class value() default Null.class;
18 |
19 | Class result() default Null.class;
20 |
21 | String stringResult() default "";
22 |
23 | String url() default "";
24 |
25 | String method() default "get";
26 |
27 | final class Null {
28 |
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/plugin/rap/ModelResponse.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.plugin.rap;
2 |
3 | /**
4 | * model response
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | class ModelResponse {
9 |
10 | private int code;
11 | private String msg;
12 | private Project model;
13 |
14 | public int getCode() {
15 | return code;
16 | }
17 |
18 | public void setCode(int code) {
19 | this.code = code;
20 | }
21 |
22 | public String getMsg() {
23 | return msg;
24 | }
25 |
26 | public void setMsg(String msg) {
27 | this.msg = msg;
28 | }
29 |
30 | public Project getModel() {
31 | return model;
32 | }
33 |
34 | public void setModel(Project model) {
35 | this.model = model;
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/resources/message_zh_CN.properties:
--------------------------------------------------------------------------------
1 | catalog=\u76ee\u5f55
2 | requestUrl=\u8bf7\u6c42URL
3 | requestParameters=\u8bf7\u6c42\u53c2\u6570
4 | requestBody=\u8bf7\u6c42\u4f53
5 | parameterName=\u53c2\u6570\u540d
6 | parameterType=\u7c7b\u578b
7 | parameterNeed=\u5fc5\u987b
8 | description=\u63cf\u8ff0
9 | responseResult=\u8fd4\u56de\u7ed3\u679c
10 | searchPlaceholder=\u641c\u7d22\u63a5\u53e3
11 | deprecated=\u8fc7\u671f
12 | yes=\u662f
13 | no=\u5426
14 | doc.generate.tip=\u672c\u6587\u6863\u7531doc-apis\u751f\u6210
15 | author=\u4f5c\u8005
16 | new=\u65b0\u589e
17 | modify=\u4fee\u6539
18 | currentVersion=\u5f53\u524d\u7248\u672c
19 | lastVersion=\u4e0a\u4e00\u7248\u672c
20 | classificationLevel=\u5BC6\u7EA7
21 | adv=\u8d5e\u52a9\u5546\u5e7f\u544a\u4f4d \u5408\u4f5c Mail:xpc@dromara.org
22 | advLink=https://www.doc-apis.com/pages/top888/
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/CodeFileBuilder.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator;
2 |
3 | /**
4 | * code file builder
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | public class CodeFileBuilder implements ICodeBuilder {
9 |
10 | private String fileName;
11 | private String codeBody;
12 | private String codeTemplate;
13 |
14 | public CodeFileBuilder(String fileName, String codeBody, String codeTemplate) {
15 | super();
16 | this.fileName = fileName;
17 | this.codeBody = codeBody;
18 | this.codeTemplate = codeTemplate;
19 | }
20 |
21 | public String build() {
22 | codeTemplate = codeTemplate.replace("${FILE_NAME}", fileName);
23 | codeTemplate = codeTemplate.replace("${MODEL_LIST}", codeBody);
24 | return codeTemplate;
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/doc-apis-test/src/main/java/com/docapis/test/model/Document.java:
--------------------------------------------------------------------------------
1 | package com.docapis.test.model;
2 |
3 | /**
4 | * 文档数据模型
5 | *
6 | * Copyright © 2024 xpc1024 All Rights Reserved
7 | **/
8 | public class Document {
9 | /**
10 | * 主键
11 | */
12 | private Long id;
13 | /**
14 | * 文档标题
15 | */
16 | private String title;
17 | /**
18 | * 文档内容
19 | */
20 | private String content;
21 |
22 | public Long getId() {
23 | return id;
24 | }
25 |
26 | public void setId(Long id) {
27 | this.id = id;
28 | }
29 |
30 | public String getTitle() {
31 | return title;
32 | }
33 |
34 | public void setTitle(String title) {
35 | this.title = title;
36 | }
37 |
38 | public String getContent() {
39 | return content;
40 | }
41 |
42 | public void setContent(String content) {
43 | this.content = content;
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/ios/builder/ModelBuilder.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.ios.builder;
2 |
3 |
4 | import com.docapis.core.codegenerator.ICodeBuilder;
5 |
6 | /**
7 | * 模型构造
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | public class ModelBuilder implements ICodeBuilder {
12 |
13 | private String modelTemplate;
14 | private String objectName;
15 | private String properties;
16 |
17 |
18 | public ModelBuilder(String modelTemplate, String objectName, String properties) {
19 | super();
20 | this.modelTemplate = modelTemplate;
21 | this.objectName = objectName;
22 | this.properties = properties;
23 | }
24 |
25 | @Override
26 | public String build() {
27 | modelTemplate = modelTemplate.replace("${CLASS_NAME}", objectName);
28 | modelTemplate = modelTemplate.replace("${FIELDS}", properties);
29 | return modelTemplate;
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/doc-apis-test/src/main/java/com/docapis/test/model/DocQuery.java:
--------------------------------------------------------------------------------
1 | package com.docapis.test.model;
2 |
3 | import javax.validation.constraints.NotNull;
4 |
5 | /**
6 | * 文档查询参数
7 | *
8 | * Copyright © 2024 xpc1024 All Rights Reserved
9 | **/
10 |
11 | public class DocQuery {
12 | /**
13 | * 标题
14 | */
15 | private String title;
16 | /**
17 | * 页码
18 | */
19 | @NotNull
20 | private Integer pageNum;
21 | /**
22 | * 每页条数
23 | */
24 | @NotNull
25 | private Integer pageSize;
26 |
27 | public String getTitle() {
28 | return title;
29 | }
30 |
31 | public void setTitle(String title) {
32 | this.title = title;
33 | }
34 |
35 | public Integer getPageNum() {
36 | return pageNum;
37 | }
38 |
39 | public void setPageNum(Integer pageNum) {
40 | this.pageNum = pageNum;
41 | }
42 |
43 | public Integer getPageSize() {
44 | return pageSize;
45 | }
46 |
47 | public void setPageSize(Integer pageSize) {
48 | this.pageSize = pageSize;
49 | }
50 | }
51 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/java/builder/JavaFieldBuilder.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.java.builder;
2 |
3 |
4 | import com.docapis.core.codegenerator.ICodeBuilder;
5 | import com.docapis.core.codegenerator.model.FieldModel;
6 |
7 | /**
8 | * java field code builder
9 | *
10 | * licence Apache 2.0, from japidoc
11 | **/
12 | public class JavaFieldBuilder implements ICodeBuilder {
13 |
14 | private String fieldTemplate;
15 | private FieldModel entryFieldModel;
16 |
17 | public JavaFieldBuilder(String fieldTemplate, FieldModel entryFieldModel) {
18 | this.fieldTemplate = fieldTemplate;
19 | this.entryFieldModel = entryFieldModel;
20 | }
21 |
22 | @Override
23 | public String build() {
24 | fieldTemplate = fieldTemplate.replace("${FIELD_TYPE}", entryFieldModel.getFieldType());
25 | fieldTemplate = fieldTemplate.replace("${FIELD_NAME}", entryFieldModel.getFieldName());
26 | fieldTemplate = fieldTemplate.replace("${COMMENT}", entryFieldModel.getComment());
27 | return fieldTemplate + "\n";
28 | }
29 | }
30 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/java/builder/JavaClassBuilder.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.java.builder;
2 |
3 |
4 | import com.docapis.core.codegenerator.ICodeBuilder;
5 |
6 | /**
7 | * java class builder
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | public class JavaClassBuilder implements ICodeBuilder {
12 |
13 | private String className;
14 | private String mFieldCode;
15 | private String mMethodCode;
16 | private String entryClassTemplate;
17 |
18 | public JavaClassBuilder(String entryClassTemplate, String className, String mFieldCode, String mMethodCode) {
19 | this.className = className;
20 | this.mFieldCode = mFieldCode;
21 | this.mMethodCode = mMethodCode;
22 | this.entryClassTemplate = entryClassTemplate;
23 | }
24 |
25 | @Override
26 | public String build() {
27 | entryClassTemplate = entryClassTemplate.replace("${CLASS_NAME}", className);
28 | entryClassTemplate = entryClassTemplate.replace("${FIELDS}", mFieldCode);
29 | entryClassTemplate = entryClassTemplate.replace("${METHODS}", mMethodCode);
30 | return entryClassTemplate;
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/ResponseNode.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | import com.alibaba.fastjson.JSONObject;
4 | import com.docapis.core.Utils;
5 |
6 | /**
7 | * response node
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | public class ResponseNode extends ClassNode {
12 |
13 | private RequestNode requestNode;
14 |
15 | private String stringResult;
16 |
17 | public RequestNode getRequestNode() {
18 | return requestNode;
19 | }
20 |
21 | public void setRequestNode(RequestNode requestNode) {
22 | this.requestNode = requestNode;
23 | }
24 |
25 | public String getStringResult() {
26 | return stringResult;
27 | }
28 |
29 | public void setStringResult(String stringResult) {
30 | this.stringResult = stringResult;
31 | }
32 |
33 | @Override
34 | public String toJsonApi() {
35 | if (stringResult != null) {
36 | try {
37 | return Utils.toPrettyJson((JSONObject.parse(stringResult)));
38 | } catch (Exception ex) {
39 | // do nothing
40 | return stringResult;
41 | }
42 | }
43 | return super.toJsonApi();
44 | }
45 | }
46 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/java/builder/JavaGetterBuilder.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.java.builder;
2 |
3 |
4 | import com.docapis.core.codegenerator.ICodeBuilder;
5 | import com.docapis.core.codegenerator.model.FieldModel;
6 |
7 | /**
8 | * java getter builder
9 | *
10 | * licence Apache 2.0, from japidoc
11 | **/
12 | public class JavaGetterBuilder implements ICodeBuilder {
13 |
14 | private String getterTemplate;
15 | private FieldModel entryFieldModel;
16 |
17 | public JavaGetterBuilder(String getterTemplate, FieldModel entryFieldModel) {
18 | this.getterTemplate = getterTemplate;
19 | this.entryFieldModel = entryFieldModel;
20 | }
21 |
22 | @Override
23 | public String build() {
24 | getterTemplate = getterTemplate.replace("${CASE_FIELD_NAME}", entryFieldModel.getCaseFieldName());
25 | getterTemplate = getterTemplate.replace("${FIELD_NAME}", entryFieldModel.getFieldName());
26 | getterTemplate = getterTemplate.replace("${FIELD_TYPE}", entryFieldModel.getFieldType());
27 | getterTemplate = getterTemplate.replace("${REMOTE_FIELD_NAME}", entryFieldModel.getRemoteFieldName());
28 | return getterTemplate + "\n";
29 | }
30 |
31 | }
32 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/java/builder/JavaSetterBuilder.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.java.builder;
2 |
3 |
4 | import com.docapis.core.codegenerator.ICodeBuilder;
5 | import com.docapis.core.codegenerator.model.FieldModel;
6 |
7 | /**
8 | * java setter builder
9 | *
10 | * licence Apache 2.0, from japidoc
11 | **/
12 | public class JavaSetterBuilder implements ICodeBuilder {
13 |
14 | private String setterTemplate;
15 | private FieldModel entryFieldModel;
16 |
17 | public JavaSetterBuilder(String setterTemplate, FieldModel entryFieldModel) {
18 | this.setterTemplate = setterTemplate;
19 | this.entryFieldModel = entryFieldModel;
20 | }
21 |
22 | @Override
23 | public String build() {
24 | setterTemplate = setterTemplate.replace("${REMOTE_FIELD_NAME}", entryFieldModel.getRemoteFieldName());
25 | setterTemplate = setterTemplate.replace("${CASE_FIELD_NAME}", entryFieldModel.getCaseFieldName());
26 | setterTemplate = setterTemplate.replace("${FIELD_NAME}", entryFieldModel.getFieldName());
27 | setterTemplate = setterTemplate.replace("${FIELD_TYPE}", entryFieldModel.getFieldType());
28 | return setterTemplate + "\n";
29 | }
30 |
31 | }
32 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/GenericControllerParser.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | import com.docapis.core.DocApi;
4 | import com.docapis.core.Utils;
5 | import com.github.javaparser.ast.body.MethodDeclaration;
6 | import com.github.javaparser.ast.expr.NormalAnnotationExpr;
7 |
8 | /**
9 | * generic controller parser
10 | *
11 | * licence Apache 2.0, from japidoc
12 | **/
13 | public class GenericControllerParser extends AbsControllerParser {
14 |
15 | @Override
16 | protected void afterHandleMethod(RequestNode requestNode, MethodDeclaration md) {
17 | md.getAnnotationByName(DocApi.class.getSimpleName()).ifPresent(an -> {
18 | if (an instanceof NormalAnnotationExpr) {
19 | ((NormalAnnotationExpr) an).getPairs().forEach(p -> {
20 | String n = p.getNameAsString();
21 | if (n.equals("url")) {
22 | requestNode.setUrl(Utils.removeQuotations(p.getValue().toString()));
23 | } else if (n.equals("method")) {
24 | requestNode.addMethod(Utils.removeQuotations(p.getValue().toString()));
25 | }
26 | });
27 | }
28 | });
29 | }
30 |
31 | }
32 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/ios/builder/ModelFieldBuilder.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.ios.builder;
2 |
3 |
4 | import com.docapis.core.codegenerator.ICodeBuilder;
5 | import com.docapis.core.codegenerator.model.FieldModel;
6 |
7 | /**
8 | * 模型字段构造
9 | *
10 | * licence Apache 2.0, from japidoc
11 | **/
12 | public class ModelFieldBuilder implements ICodeBuilder {
13 |
14 | private String modelFieldTemplate;
15 | private FieldModel entryFieldModel;
16 |
17 | public ModelFieldBuilder(String modelFieldTemplate, FieldModel entryFieldModel) {
18 | super();
19 | this.modelFieldTemplate = modelFieldTemplate;
20 | this.entryFieldModel = entryFieldModel;
21 | }
22 |
23 | @Override
24 | public String build() {
25 | modelFieldTemplate = modelFieldTemplate.replace("${FIELD_TYPE}", entryFieldModel.getIFieldType());
26 | modelFieldTemplate = modelFieldTemplate.replace("${FIELD_NAME}", entryFieldModel.getFieldName());
27 | modelFieldTemplate = modelFieldTemplate.replace("${COMMENT}", entryFieldModel.getComment());
28 | modelFieldTemplate = modelFieldTemplate.replace("${ASSIGN}", entryFieldModel.getAssign());
29 | return modelFieldTemplate + "\n";
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/doc-apis-core/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 | 4.0.0
6 |
7 |
8 | com.doc-apis
9 | doc-apis-parent
10 | 1.0.0
11 | ../doc-apis-parent
12 |
13 |
14 | doc-apis-core
15 |
16 |
17 | 8
18 | 8
19 |
20 |
21 |
22 |
23 | com.alibaba
24 | fastjson
25 |
26 |
27 | com.github.javaparser
28 | javaparser-core
29 |
30 |
31 | org.freemarker
32 | freemarker
33 |
34 |
35 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/http/DHttpRequest.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.http;
2 |
3 | import java.util.HashMap;
4 | import java.util.Map;
5 |
6 | /**
7 | * http request
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | public class DHttpRequest {
12 |
13 | private String url;
14 | private boolean autoRedirect = true; //自动重定向
15 | private Map params = new HashMap<>();
16 | private Map headers;
17 |
18 | public String getUrl() {
19 | return url;
20 | }
21 |
22 | public void setUrl(String url) {
23 | this.url = url;
24 | }
25 |
26 | public Map getParams() {
27 | return params;
28 | }
29 |
30 | public void setParams(Map params) {
31 | this.params = params;
32 | }
33 |
34 | public Map getHeaders() {
35 | return headers;
36 | }
37 |
38 | public void setHeaders(Map headers) {
39 | this.headers = headers;
40 | }
41 |
42 | public void addParam(String name, String value) {
43 | params.put(name, value);
44 | }
45 |
46 | public boolean isAutoRedirect() {
47 | return autoRedirect;
48 | }
49 |
50 | public void setAutoRedirect(boolean autoRedirect) {
51 | this.autoRedirect = autoRedirect;
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/ParamNode.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | /**
4 | * param node
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | public class ParamNode {
9 |
10 | private String name;
11 | private String type;
12 | private Boolean required = Boolean.FALSE;
13 | private String description;
14 | private Boolean jsonBody = Boolean.FALSE;// when true ,the json body set to description
15 |
16 | public String getName() {
17 | return name;
18 | }
19 |
20 | public void setName(String name) {
21 | this.name = name;
22 | }
23 |
24 | public String getType() {
25 | return type;
26 | }
27 |
28 | public void setType(String type) {
29 | this.type = type;
30 | }
31 |
32 |
33 | public String getDescription() {
34 | return description;
35 | }
36 |
37 | public void setDescription(String description) {
38 | this.description = description;
39 | }
40 |
41 | public Boolean getRequired() {
42 | return required;
43 | }
44 |
45 | public void setRequired(Boolean required) {
46 | this.required = required;
47 | }
48 |
49 | public Boolean getJsonBody() {
50 | return jsonBody;
51 | }
52 |
53 | public void setJsonBody(Boolean jsonBody) {
54 | this.jsonBody = jsonBody;
55 | }
56 | }
57 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/LogUtils.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core;
2 |
3 | import java.io.IOException;
4 | import java.util.logging.FileHandler;
5 | import java.util.logging.Level;
6 | import java.util.logging.Logger;
7 | import java.util.logging.SimpleFormatter;
8 |
9 | /**
10 | * log utils
11 | *
12 | * licence Apache 2.0, from japidoc
13 | **/
14 | public class LogUtils {
15 |
16 | private static final Logger LOGGER = Logger.getGlobal();
17 |
18 | static {
19 | try {
20 | FileHandler fileHandler = new FileHandler(DocContext.getLogFile().getAbsolutePath());
21 | fileHandler.setFormatter(new SimpleFormatter());
22 | fileHandler.setLevel(Level.ALL);
23 | LOGGER.addHandler(fileHandler);
24 | } catch (IOException e) {
25 | e.printStackTrace();
26 | }
27 | }
28 |
29 | public static void info(String message, Object... args) {
30 | LOGGER.info(String.format(message, args));
31 | }
32 |
33 | public static void warn(String message, Object... args) {
34 | LOGGER.warning(String.format(message, args));
35 | }
36 |
37 | public static void error(String message, Object... args) {
38 | LOGGER.severe(String.format(message, args));
39 | }
40 |
41 | public static void error(String message, Throwable e) {
42 | LOGGER.log(Level.SEVERE, message, e);
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/JFinalControllerParser.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | import com.docapis.core.Utils;
4 | import com.github.javaparser.ast.body.MethodDeclaration;
5 | import com.github.javaparser.ast.expr.SingleMemberAnnotationExpr;
6 |
7 | import java.util.Arrays;
8 |
9 | /**
10 | * jFinal controller parser
11 | *
12 | * licence Apache 2.0, from japidoc
13 | **/
14 | public class JFinalControllerParser extends AbsControllerParser {
15 |
16 | @Override
17 | protected void afterHandleMethod(RequestNode requestNode, MethodDeclaration md) {
18 | String methodName = md.getNameAsString();
19 | requestNode.setUrl(getUrl(methodName));
20 | md.getAnnotationByName("ActionKey").ifPresent(an -> {
21 | if (an instanceof SingleMemberAnnotationExpr) {
22 | String url = ((SingleMemberAnnotationExpr) an).getMemberValue().toString();
23 | requestNode.setMethod(Arrays.asList(RequestMethod.GET.name(), RequestMethod.POST.name()));
24 | requestNode.setUrl(Utils.removeQuotations(url));
25 | return;
26 | }
27 | });
28 | }
29 |
30 | private String getUrl(String methodName) {
31 | JFinalRoutesParser.RouteNode routeNode = JFinalRoutesParser.INSTANCE.getRouteNode(getControllerFile().getAbsolutePath());
32 | return routeNode == null ? "" : routeNode.basicUrl + "/" + methodName;
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/http/DHttpResponse.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.http;
2 |
3 |
4 | import com.docapis.core.Utils;
5 |
6 | import java.io.IOException;
7 | import java.io.InputStream;
8 | import java.util.HashMap;
9 | import java.util.Map;
10 |
11 | /**
12 | * http response
13 | *
14 | * licence Apache 2.0, from japidoc
15 | **/
16 | public class DHttpResponse {
17 |
18 | private int code;
19 | private InputStream stream;
20 | private Map headers = new HashMap<>();
21 |
22 | public int getCode() {
23 | return code;
24 | }
25 |
26 | void setCode(int code) {
27 | this.code = code;
28 | }
29 |
30 | public InputStream getStream() {
31 | return stream;
32 | }
33 |
34 | void setStream(InputStream stream) {
35 | this.stream = stream;
36 | }
37 |
38 | public Map getHeaders() {
39 | return headers;
40 | }
41 |
42 | void setHeaders(Map headers) {
43 | this.headers = headers;
44 | }
45 |
46 | void addHeader(String key, String value) {
47 | this.headers.put(key, value);
48 | }
49 |
50 | public String getHeader(String header) {
51 | return headers.get(header);
52 | }
53 |
54 | public String streamAsString() {
55 | try {
56 | return Utils.streamToString(stream);
57 | } catch (IOException e) {
58 | throw new RuntimeException(e);
59 | }
60 | }
61 | }
62 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/PlayControllerParser.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | import com.github.javaparser.ast.body.MethodDeclaration;
4 |
5 | import java.util.Arrays;
6 |
7 | /**
8 | * play controller parser
9 | *
10 | * licence Apache 2.0, from japidoc
11 | **/
12 | public class PlayControllerParser extends AbsControllerParser {
13 |
14 | @Override
15 | protected void afterHandleMethod(RequestNode requestNode, MethodDeclaration md) {
16 | PlayRoutesParser.RouteNode routeNode = PlayRoutesParser.INSTANCE.getRouteNode(getControllerFile(), md.getNameAsString());
17 | if (routeNode == null) {
18 | return;
19 | }
20 |
21 | String method = routeNode.method.toUpperCase();
22 | if ("*".equals(method)) {
23 | requestNode.setMethod(Arrays.asList(RequestMethod.GET.name(), RequestMethod.POST.name()));
24 | } else {
25 | requestNode.addMethod(RequestMethod.valueOf(method).name());
26 | }
27 |
28 | requestNode.setUrl(routeNode.routeUrl);
29 |
30 | md.getParameters().forEach(p -> {
31 | String paraName = p.getName().asString();
32 | ParamNode paramNode = requestNode.getParamNodeByName(paraName);
33 | if (paramNode != null) {
34 | p.getAnnotationByName("Required").ifPresent(r -> {
35 | paramNode.setRequired(true);
36 | });
37 | }
38 | });
39 | }
40 |
41 | }
42 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/plugin/rap/ProjectForm.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.plugin.rap;
2 |
3 | /**
4 | * project form
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | class ProjectForm {
9 |
10 | private Integer id;
11 | private String projectData;
12 | private String deletedObjectListData;
13 | private String versionPosition;
14 | private String description;
15 |
16 | public Integer getId() {
17 | return id;
18 | }
19 |
20 | public void setId(Integer id) {
21 | this.id = id;
22 | }
23 |
24 | public String getProjectData() {
25 | return projectData;
26 | }
27 |
28 | public void setProjectData(String projectData) {
29 | this.projectData = projectData;
30 | }
31 |
32 | public String getDeletedObjectListData() {
33 | return deletedObjectListData;
34 | }
35 |
36 | public void setDeletedObjectListData(String deletedObjectListData) {
37 | this.deletedObjectListData = deletedObjectListData;
38 | }
39 |
40 | public String getVersionPosition() {
41 | return versionPosition == null ? "4" : versionPosition;
42 | }
43 |
44 | public void setVersionPosition(String versionPosition) {
45 | this.versionPosition = versionPosition;
46 | }
47 |
48 | public String getDescription() {
49 | return description;
50 | }
51 |
52 | public void setDescription(String description) {
53 | this.description = description;
54 | }
55 | }
56 |
--------------------------------------------------------------------------------
/doc-apis-starter/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 | 4.0.0
6 |
7 |
8 | com.doc-apis
9 | doc-apis-parent
10 | 1.0.0
11 | ../doc-apis-parent
12 |
13 |
14 | doc-apis-starter
15 |
16 |
17 | 8
18 | 8
19 |
20 |
21 |
22 |
23 |
24 | org.springframework.boot
25 | spring-boot-configuration-processor
26 | true
27 |
28 |
29 | org.springframework.boot
30 | spring-boot-starter
31 |
32 |
33 | org.springframework.boot
34 | spring-boot-starter-web
35 | provided
36 |
37 |
38 | com.doc-apis
39 | doc-apis-core
40 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/provider/DocFieldProvider.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.provider;
2 |
3 |
4 | import com.docapis.core.Utils;
5 | import com.docapis.core.codegenerator.IFieldProvider;
6 | import com.docapis.core.codegenerator.model.FieldModel;
7 | import com.docapis.core.parser.ClassNode;
8 | import com.docapis.core.parser.FieldNode;
9 |
10 | import java.util.ArrayList;
11 | import java.util.List;
12 |
13 | /**
14 | * doc field provider
15 | *
16 | * licence Apache 2.0, from japidoc
17 | **/
18 | public class DocFieldProvider implements IFieldProvider {
19 |
20 | @Override
21 | public List provideFields(ClassNode respNode) {
22 | List recordNodes = respNode.getChildNodes();
23 | if (recordNodes == null || recordNodes.isEmpty()) {
24 | return null;
25 | }
26 | List entryFieldList = new ArrayList<>();
27 | FieldModel entryField;
28 | for (FieldNode recordNode : recordNodes) {
29 | entryField = new FieldModel();
30 | String fieldName = DocFieldHelper.getPrefFieldName(recordNode.getName());
31 | entryField.setCaseFieldName(Utils.capitalize(fieldName));
32 | entryField.setFieldName(fieldName);
33 | entryField.setFieldType(DocFieldHelper.getPrefFieldType(recordNode.getType()));
34 | entryField.setRemoteFieldName(recordNode.getName());
35 | entryField.setComment(recordNode.getDescription());
36 | entryFieldList.add(entryField);
37 | }
38 | return entryFieldList;
39 | }
40 |
41 | }
42 |
--------------------------------------------------------------------------------
/doc-apis-test/src/main/java/com/docapis/test/model/ApiResult.java:
--------------------------------------------------------------------------------
1 | package com.docapis.test.model;
2 |
3 | /**
4 | * 统一返回
5 | *
6 | * Copyright © 2024 xpc1024 All Rights Reserved
7 | **/
8 | public class ApiResult {
9 | /**
10 | * 数据
11 | */
12 | private T data;
13 | /**
14 | * 状态码
15 | */
16 | private Integer code;
17 | /**
18 | * 消息
19 | */
20 | private String msg;
21 |
22 | public T getData() {
23 | return data;
24 | }
25 |
26 | public void setData(T data) {
27 | this.data = data;
28 | }
29 |
30 | public Integer getCode() {
31 | return code;
32 | }
33 |
34 | public void setCode(Integer code) {
35 | this.code = code;
36 | }
37 |
38 | public String getMsg() {
39 | return msg;
40 | }
41 |
42 | public void setMsg(String msg) {
43 | this.msg = msg;
44 | }
45 |
46 | public static ApiResult success(T data) {
47 | ApiResult result = new ApiResult();
48 | result.setCode(200);
49 | result.setData(data);
50 | result.setMsg("success");
51 | return result;
52 | }
53 |
54 | public static ApiResult success() {
55 | ApiResult result = new ApiResult();
56 | result.setCode(200);
57 | result.setMsg("success");
58 | return result;
59 | }
60 |
61 | public static ApiResult error(Integer code, String msg) {
62 | ApiResult result = new ApiResult();
63 | result.setCode(code);
64 | result.setData(null);
65 | result.setMsg(msg);
66 | return result;
67 | }
68 | }
69 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/resources/api-common-catalog.html.ftl:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | <#list controllerNodeList as ctrolNode>
7 |
8 |
10 | ${ctrolNode.description}
11 |
12 |
24 |
25 |
26 |
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | class Page {
12 |
13 | private int id;
14 | private String name;
15 | private String introduction;
16 | private Module module;
17 | private Set actionList = new HashSet();
18 | private String template;
19 |
20 | public static Page newPage() {
21 | Page page = new Page();
22 | page.setId(-1);
23 | return page;
24 | }
25 |
26 | public int getId() {
27 | return id;
28 | }
29 |
30 | public void setId(int id) {
31 | this.id = id;
32 | }
33 |
34 | public String getName() {
35 | return name;
36 | }
37 |
38 | public void setName(String name) {
39 | this.name = name;
40 | }
41 |
42 | public String getIntroduction() {
43 | return introduction;
44 | }
45 |
46 | public void setIntroduction(String introduction) {
47 | this.introduction = introduction;
48 | }
49 |
50 | public Module getModule() {
51 | return module;
52 | }
53 |
54 | public void setModule(Module module) {
55 | this.module = module;
56 | }
57 |
58 | public Set getActionList() {
59 | return actionList;
60 | }
61 |
62 | public void setActionList(Set actionList) {
63 | this.actionList = actionList;
64 | }
65 |
66 | public String getTemplate() {
67 | return template;
68 | }
69 |
70 | public void setTemplate(String template) {
71 | this.template = template;
72 | }
73 | }
74 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/GenericNode.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | import com.github.javaparser.ast.type.Type;
4 |
5 | import java.io.File;
6 | import java.util.ArrayList;
7 | import java.util.List;
8 |
9 | /**
10 | * generic node
11 | *
12 | * licence Apache 2.0, from japidoc
13 | **/
14 | public class GenericNode {
15 |
16 | private Type classType;
17 | private Class modelClass;
18 | private String placeholder;
19 | private File fromJavaFile;
20 | private List childGenericNode = new ArrayList<>();
21 |
22 | public GenericNode() {
23 | }
24 |
25 | public Type getClassType() {
26 | return classType;
27 | }
28 |
29 | public void setClassType(Type classType) {
30 | this.classType = classType;
31 | }
32 |
33 | public File getFromJavaFile() {
34 | return fromJavaFile;
35 | }
36 |
37 | public void setFromJavaFile(File fromJavaFile) {
38 | this.fromJavaFile = fromJavaFile;
39 | }
40 |
41 | public List getChildGenericNode() {
42 | return childGenericNode;
43 | }
44 |
45 | public void setChildGenericNode(List childGenericNode) {
46 | this.childGenericNode = childGenericNode;
47 | }
48 |
49 | public void addChildGenericNode(GenericNode childNode) {
50 | this.childGenericNode.add(childNode);
51 | }
52 |
53 | public String getPlaceholder() {
54 | return placeholder;
55 | }
56 |
57 |
58 | public void setPlaceholder(String placeholder) {
59 | this.placeholder = placeholder;
60 | }
61 |
62 | public Class getModelClass() {
63 | return modelClass;
64 | }
65 |
66 | public void setModelClass(Class modelClass) {
67 | this.modelClass = modelClass;
68 | }
69 | }
70 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/plugin/rap/Module.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.plugin.rap;
2 |
3 | import java.util.HashSet;
4 | import java.util.Set;
5 |
6 | /**
7 | * module
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | class Module {
12 |
13 | public static final String NAME = "API List";
14 |
15 | private int id;
16 | private int projectId;
17 | private String name;
18 | private String introduction;
19 | private Project project;
20 | private Set pageList = new HashSet();
21 |
22 | public static Module newModule() {
23 | Module module = new Module();
24 | module.setId(-1);
25 | module.setName(NAME);
26 | return module;
27 | }
28 |
29 | public int getId() {
30 | return id;
31 | }
32 |
33 | public void setId(int id) {
34 | this.id = id;
35 | }
36 |
37 | public int getProjectId() {
38 | return projectId;
39 | }
40 |
41 | public void setProjectId(int projectId) {
42 | this.projectId = projectId;
43 | }
44 |
45 | public String getName() {
46 | return name;
47 | }
48 |
49 | public void setName(String name) {
50 | this.name = name;
51 | }
52 |
53 | public String getIntroduction() {
54 | return introduction;
55 | }
56 |
57 | public void setIntroduction(String introduction) {
58 | this.introduction = introduction;
59 | }
60 |
61 | public Project getProject() {
62 | return project;
63 | }
64 |
65 | public void setProject(Project project) {
66 | this.project = project;
67 | }
68 |
69 | public Set getPageList() {
70 | return pageList;
71 | }
72 |
73 | public void setPageList(Set pageList) {
74 | this.pageList = pageList;
75 | }
76 | }
77 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/model/FieldModel.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.model;
2 |
3 |
4 | import com.docapis.core.codegenerator.provider.DocFieldHelper;
5 |
6 | /**
7 | * field model
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | public class FieldModel {
12 |
13 | private String remoteFieldName;
14 | private String caseFieldName;
15 | private String fieldName;
16 | private String fieldType;
17 | private String comment;
18 |
19 | public String getFieldName() {
20 | return fieldName;
21 | }
22 |
23 | public void setFieldName(String fieldName) {
24 | this.fieldName = fieldName;
25 | }
26 |
27 | public String getFieldType() {
28 | return fieldType;
29 | }
30 |
31 | public String getIFieldType() {
32 | return DocFieldHelper.getIosFieldType(fieldType);
33 | }
34 |
35 | public void setFieldType(String fieldType) {
36 | this.fieldType = fieldType;
37 | }
38 |
39 | public String getRemoteFieldName() {
40 | return remoteFieldName;
41 | }
42 |
43 | public void setRemoteFieldName(String remoteFieldName) {
44 | this.remoteFieldName = remoteFieldName;
45 | }
46 |
47 | public String getCaseFieldName() {
48 | return caseFieldName;
49 | }
50 |
51 | public void setCaseFieldName(String caseFieldName) {
52 | this.caseFieldName = caseFieldName;
53 | }
54 |
55 | public String getComment() {
56 | return comment == null ? "" : comment;
57 | }
58 |
59 | public void setComment(String comment) {
60 | this.comment = comment;
61 | }
62 |
63 | public String getAssign() {
64 | if (fieldType != null && fieldType.equalsIgnoreCase("string")) {
65 | return "assign";
66 | } else {
67 | return "strong";
68 | }
69 | }
70 |
71 | }
72 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 | 4.0.0
6 | pom
7 |
8 | com.doc-apis
9 | doc-apis
10 | 1.0.0
11 |
12 | doc-apis
13 | doc generator
14 |
15 |
16 | doc-apis-parent
17 | doc-apis-test
18 |
19 |
20 |
21 | 1.0.0
22 | 2.7.6
23 | 5.3.3
24 |
25 |
26 |
27 |
28 |
29 | com.doc-apis
30 | doc-apis-starter
31 | ${doc-apis.version}
32 |
33 |
34 | org.springframework.boot
35 | spring-boot-starter-web
36 | ${springboot.version}
37 |
38 |
39 | org.springframework.boot
40 | spring-boot-starter-test
41 | ${springboot.version}
42 |
43 |
44 | com.github.pagehelper
45 | pagehelper
46 | ${pageHelper.version}
47 |
48 |
49 |
50 |
51 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/resources/api-doc.md.ftl:
--------------------------------------------------------------------------------
1 |
2 | > This documentation is generated by [doc-apis](https://www.doc-apis.com/).
3 | ---
4 | <#list controllerNodes as controller>
5 | # ${controller.description}
6 | <#list controller.requestNodes as reqNode>
7 | ## <#if reqNode.deprecated>~~${(reqNode.description)!''}~~<#else>${(reqNode.description)!''}
8 |
9 | *<#if reqNode.author??>${i18n.getMessage('author')}: ${reqNode.author}*
10 |
11 | **${i18n.getMessage('requestUrl')}**
12 |
13 | ${reqNode.url} <#list reqNode.method as method>`${method}`
14 |
15 | <#if reqNode.paramNodes?size != 0>
16 | <#assign requestJsonBody = ''/>
17 | <#list reqNode.paramNodes as paramNode>
18 | <#if paramNode.jsonBody>
19 | <#assign requestJsonBody = paramNode.description/>
20 |
21 |
22 | <#if requestJsonBody == '' || (requestJsonBody != '' && reqNode.paramNodes?size gt 1)>
23 | **${i18n.getMessage('requestParameters')}**
24 |
25 | ${i18n.getMessage('parameterName')!''}|${i18n.getMessage('parameterType')!''}|${i18n.getMessage('parameterNeed')}|${i18n.getMessage('description')!''}
26 | --:|:--:|:--:|:--
27 | <#list reqNode.paramNodes as paramNode>
28 | <#if !(paramNode.jsonBody)>
29 | ${paramNode.name}|${paramNode.type!''}|${paramNode.required?string(i18n.getMessage('yes'),i18n.getMessage('no'))}|${(paramNode.description)!''}
30 |
31 |
32 |
33 | <#if requestJsonBody != ''>
34 | **${i18n.getMessage('requestBody')}**
35 |
36 | ```json
37 | ${requestJsonBody}
38 | ```
39 |
40 |
41 |
42 | <#if reqNode.responseNode??>
43 | **${i18n.getMessage('responseResult')}**
44 |
45 | ```json
46 | ${reqNode.responseNode.toJsonApi()}
47 | ```
48 |
49 |
50 |
51 |
52 |
53 |
54 | ${i18n.getMessage('classificationLevel')}:${classificationLevel}
55 |
56 |
57 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/FieldNode.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | /**
4 | * field node
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | public class FieldNode {
9 |
10 | private String name;
11 | private String type;
12 | private String description;
13 | private MockNode mockNode;
14 | private ClassNode childNode;
15 | private ClassNode classNode;
16 | private Boolean loopNode = Boolean.FALSE;
17 | private Boolean notNull = Boolean.FALSE;
18 |
19 | public Boolean getLoopNode() {
20 | return loopNode;
21 | }
22 |
23 | public void setLoopNode(Boolean loopNode) {
24 | this.loopNode = loopNode;
25 | }
26 |
27 | public Boolean getNotNull() {
28 | return notNull;
29 | }
30 |
31 | public void setNotNull(Boolean notNull) {
32 | this.notNull = notNull;
33 | }
34 |
35 | public String getName() {
36 | return name;
37 | }
38 |
39 | public void setName(String name) {
40 | this.name = name;
41 | }
42 |
43 | public String getType() {
44 | return type;
45 | }
46 |
47 | public void setType(String type) {
48 | this.type = type;
49 | }
50 |
51 | public String getDescription() {
52 | return description;
53 | }
54 |
55 | public void setDescription(String description) {
56 | this.description = description;
57 | }
58 |
59 | public MockNode getMockNode() {
60 | return mockNode;
61 | }
62 |
63 | public void setMockNode(MockNode mockNode) {
64 | this.mockNode = mockNode;
65 | }
66 |
67 | public ClassNode getChildNode() {
68 | return childNode;
69 | }
70 |
71 | public void setChildNode(ClassNode childNode) {
72 | this.childNode = childNode;
73 | }
74 |
75 | public ClassNode getClassNode() {
76 | return classNode;
77 | }
78 |
79 | public void setClassNode(ClassNode classNode) {
80 | this.classNode = classNode;
81 | }
82 |
83 | }
84 |
--------------------------------------------------------------------------------
/doc-apis-test/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
5 | 4.0.0
6 |
7 |
8 | com.doc-apis
9 | doc-apis
10 | 1.0.0
11 |
12 |
13 | doc-apis-test
14 |
15 |
16 | 8
17 | 8
18 |
19 |
20 |
21 |
22 | com.doc-apis
23 | doc-apis-starter
24 |
25 |
26 |
27 | org.springframework.boot
28 | spring-boot-starter-web
29 |
30 |
31 | org.springframework.boot
32 | spring-boot-starter-test
33 |
34 |
35 | com.github.pagehelper
36 | pagehelper
37 |
38 |
39 | org.dromara.easy-es
40 | easy-es-boot-starter
41 | 2.0.0-beta8
42 |
43 |
44 |
45 | javax.validation
46 | validation-api
47 | 2.0.1.Final
48 |
49 |
50 |
51 |
--------------------------------------------------------------------------------
/doc-apis-starter/src/main/java/com/docapis/starter/config/CorsConfig.java:
--------------------------------------------------------------------------------
1 | package com.docapis.starter.config;
2 |
3 | import com.docapis.starter.property.CorsConfigProperties;
4 | import com.docapis.starter.property.DocPlusConfigProperties;
5 | import org.springframework.beans.factory.annotation.Autowired;
6 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
7 | import org.springframework.context.annotation.Configuration;
8 | import org.springframework.web.servlet.config.annotation.CorsRegistry;
9 | import org.springframework.web.servlet.config.annotation.EnableWebMvc;
10 | import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
11 |
12 | import static com.docapis.core.constant.CoreConstants.COMMA_SIGN;
13 |
14 | /**
15 | * 跨域自动配置
16 | *
17 | * Copyright © 2024 xpc1024 All Rights Reserved
18 | **/
19 | @Configuration
20 | @EnableWebMvc
21 | @ConditionalOnProperty(prefix = "doc-apis.corsConfig", name = {"allowCors"}, havingValue = "true", matchIfMissing = true)
22 | public class CorsConfig implements WebMvcConfigurer {
23 | @Autowired
24 | private DocPlusConfigProperties docPlusConfigProperties;
25 |
26 | @Override
27 | public void addCorsMappings(CorsRegistry registry) {
28 | CorsConfigProperties config = docPlusConfigProperties.getCorsConfig();
29 | String[] allowedOriginPatterns = config.getAllowedOriginPatterns().split(COMMA_SIGN);
30 | String[] allowedMethods = config.getAllowedMethods().split(COMMA_SIGN);
31 | String[] allowedHeaders = config.getAllowedHeaders().split(COMMA_SIGN);
32 | registry.addMapping(config.getPathPattern())
33 | // 设置允许跨域请求的域名
34 | .allowedOriginPatterns(allowedOriginPatterns)
35 | // 设置允许的方法
36 | .allowedMethods(allowedMethods)
37 | // 允许的请求头
38 | .allowedHeaders(allowedHeaders)
39 | // 跨域允许时间
40 | .maxAge(config.getMaxAge())
41 | // 是否允许证书 不在默认开启
42 | .allowCredentials(config.isAllowCredentials());
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/doc-apis-test/src/main/java/com/docapis/test/controller/SampleController.java:
--------------------------------------------------------------------------------
1 | package com.docapis.test.controller;
2 |
3 | import com.docapis.test.model.ApiResult;
4 | import com.docapis.test.model.DocQuery;
5 | import com.docapis.test.model.Document;
6 | import com.github.pagehelper.PageInfo;
7 | import org.springframework.web.bind.annotation.*;
8 |
9 | import javax.validation.Valid;
10 | import java.util.Collections;
11 |
12 | /**
13 | * 示例接口
14 | **/
15 | @RestController
16 | @RequestMapping("/sample")
17 | public class SampleController {
18 | /**
19 | * 分页获取文档列表
20 | *
21 | * @param docQuery 文档分页查询参数
22 | * @return 分页数据
23 | */
24 | @PostMapping("/page")
25 | public ApiResult> pageList(@RequestBody @Valid DocQuery docQuery) {
26 | Document document = new Document();
27 | document.setId(1L);
28 | document.setTitle("老汉");
29 | document.setContent("推*");
30 | PageInfo pageInfo = new PageInfo<>(Collections.singletonList(document));
31 | return ApiResult.success(pageInfo);
32 | }
33 |
34 | /**
35 | * 获取文档详情
36 | *
37 | * @param documentId 文档id
38 | * @return 文档详情
39 | */
40 | @GetMapping("/getDocment")
41 | public ApiResult document(@RequestParam Long documentId) {
42 | Document document = new Document();
43 | document.setId(1L);
44 | document.setTitle("老汉");
45 | document.setContent("推*");
46 | return ApiResult.success(document);
47 | }
48 |
49 | /**
50 | * 更新文档
51 | *
52 | * @param document 文档信息
53 | * @return 更新结果
54 | */
55 | @PutMapping("/updateDocument")
56 | public ApiResult updateDocument(@RequestBody Document document) {
57 | return ApiResult.success(Boolean.TRUE);
58 | }
59 |
60 | /**
61 | * 删除文档
62 | *
63 | * @param documentId 文档id
64 | * @return 删除结果
65 | */
66 | @DeleteMapping("/delDocument")
67 | public ApiResult delDocument(@RequestParam Long documentId) {
68 | return ApiResult.success(Boolean.TRUE);
69 | }
70 |
71 |
72 | }
73 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/plugin/markdown/MarkdownDocPlugin.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.plugin.markdown;
2 |
3 | import com.docapis.core.DocContext;
4 | import com.docapis.core.IPluginSupport;
5 | import com.docapis.core.Resources;
6 | import com.docapis.core.Utils;
7 | import com.docapis.core.parser.ControllerNode;
8 | import freemarker.template.Template;
9 | import freemarker.template.TemplateException;
10 |
11 |
12 | import java.io.File;
13 | import java.io.FileWriter;
14 | import java.io.IOException;
15 | import java.util.HashMap;
16 | import java.util.List;
17 | import java.util.Map;
18 |
19 | /**
20 | * abstract doc generator
21 | *
22 | * licence Apache 2.0,AGPL-3.0, from japidoc and doc-apis originated
23 | **/
24 | public class MarkdownDocPlugin implements IPluginSupport {
25 |
26 | @Override
27 | public void execute(List controllerNodeList) {
28 | FileWriter docFileWriter = null;
29 | try {
30 | final Template ctrlTemplate = getDocTpl();
31 | final String docFileName = String.format("%s-%s.md", DocContext.getDocsConfig().getProjectName(), DocContext.getDocsConfig().getApiVersion());
32 | final File docFile = new File(DocContext.getDocPath(), docFileName);
33 | docFileWriter = new FileWriter(docFile);
34 | Map data = new HashMap<>();
35 | data.put("controllerNodes", controllerNodeList);
36 | data.put("currentApiVersion", DocContext.getCurrentApiVersion());
37 | data.put("projectName", DocContext.getDocsConfig().getProjectName());
38 | data.put("i18n", DocContext.getI18n());
39 | data.put("classificationLevel", DocContext.getDocsConfig().getClassificationLevel());
40 | ctrlTemplate.process(data, docFileWriter);
41 | } catch (TemplateException | IOException ex) {
42 | ex.printStackTrace();
43 | } finally {
44 | Utils.closeSilently(docFileWriter);
45 | }
46 | }
47 |
48 | private Template getDocTpl() throws IOException {
49 | return Resources.getFreemarkerTemplate("api-doc.md.ftl");
50 | }
51 | }
52 |
--------------------------------------------------------------------------------
/doc-apis-starter/src/main/java/com/docapis/starter/property/CorsConfigProperties.java:
--------------------------------------------------------------------------------
1 | package com.docapis.starter.property;
2 |
3 | /**
4 | * 自动跨域配置参数
5 | *
6 | * Copyright © 2024 xpc1024 All Rights Reserved
7 | **/
8 | public class CorsConfigProperties {
9 | /**
10 | * 是否开启跨域
11 | */
12 | private boolean allowCors = true;
13 | /**
14 | * 跨域允许时间
15 | */
16 | private Long maxAge = 3600L;
17 | /**
18 | * 允许跨域请求的域名
19 | */
20 | private String pathPattern = "/**";
21 | /**
22 | * 允许跨域的来源模式
23 | */
24 | private String allowedOriginPatterns = "*";
25 | /**
26 | * 允许跨域的方法
27 | */
28 | private String allowedMethods = "*";
29 | /**
30 | * 跨域允许请求头
31 | */
32 | private String allowedHeaders = "*";
33 | /**
34 | * 是否允许证书
35 | */
36 | private boolean allowCredentials = true;
37 |
38 | public boolean isAllowCors() {
39 | return allowCors;
40 | }
41 |
42 | public void setAllowCors(boolean allowCors) {
43 | this.allowCors = allowCors;
44 | }
45 |
46 | public Long getMaxAge() {
47 | return maxAge;
48 | }
49 |
50 | public void setMaxAge(Long maxAge) {
51 | this.maxAge = maxAge;
52 | }
53 |
54 | public String getPathPattern() {
55 | return pathPattern;
56 | }
57 |
58 | public void setPathPattern(String pathPattern) {
59 | this.pathPattern = pathPattern;
60 | }
61 |
62 | public String getAllowedOriginPatterns() {
63 | return allowedOriginPatterns;
64 | }
65 |
66 | public void setAllowedOriginPatterns(String allowedOriginPatterns) {
67 | this.allowedOriginPatterns = allowedOriginPatterns;
68 | }
69 |
70 | public String getAllowedMethods() {
71 | return allowedMethods;
72 | }
73 |
74 | public void setAllowedMethods(String allowedMethods) {
75 | this.allowedMethods = allowedMethods;
76 | }
77 |
78 | public String getAllowedHeaders() {
79 | return allowedHeaders;
80 | }
81 |
82 | public void setAllowedHeaders(String allowedHeaders) {
83 | this.allowedHeaders = allowedHeaders;
84 | }
85 |
86 | public boolean isAllowCredentials() {
87 | return allowCredentials;
88 | }
89 |
90 | public void setAllowCredentials(boolean allowCredentials) {
91 | this.allowCredentials = allowCredentials;
92 | }
93 | }
94 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/constant/CoreConstants.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.constant;
2 |
3 |
4 | import java.io.File;
5 |
6 | /**
7 | * 核心常量
8 | *
9 | * Copyright © 2024 xpc1024 All Rights Reserved
10 | **/
11 | public interface CoreConstants {
12 | /**
13 | * 版本号发版及包调整时须更新此字段,死贫道不能死道友,此举可使用户可免配
14 | */
15 | String VERSION = "1.0.0";
16 | /**
17 | * jar 完整路径
18 | */
19 | String JAR_PATH = "com" + File.separator + "doc-apis" + File.separator + "doc-apis-core" + File.separator + VERSION + File.separator + "doc-apis-core-" + VERSION + ".jar";
20 | /**
21 | * 分隔符
22 | */
23 | String SEPATOR = "/";
24 | /**
25 | * comma
26 | */
27 | String COMMA_SIGN = ",";
28 | /**
29 | * 当前项目目录
30 | */
31 | String USER_DIR = "user.dir";
32 | /**
33 | * js存放路径
34 | */
35 | String JS_PATH = "js";
36 | /**
37 | * 图片存放路径
38 | */
39 | String IMG_PATH = "img";
40 | /**
41 | * css存放路径
42 | */
43 | String CSS_PATH = "css";
44 | /**
45 | * 字体存放路径
46 | */
47 | String FONT_PATH = "fonts";
48 | /**
49 | * html存放路径
50 | */
51 | String HTML_PATH = "html";
52 |
53 |
54 | String LOGO_NAME = "logo.png";
55 | /**
56 | * pageInfo 类名
57 | */
58 | String PAGE_INFO_NAME = "PageInfo";
59 | /**
60 | * pageInfo 文件名
61 | */
62 | String PAGE_INFO_FILE = "PageInfo.java";
63 | /**
64 | * esPageInfo 类名
65 | */
66 | String ES_PAGE_INFO_NAME = "EsPageInfo";
67 | /**
68 | * esPageInfo 文件名
69 | */
70 | String ES_PAGE_INFO_FILE = "EsPageInfo.java";
71 | /**
72 | * java 文件后缀
73 | */
74 | String JAVA_FILE_SUFFIX = ".java";
75 | /**
76 | * 内部依赖的所有js列表
77 | */
78 | String JS_NAMES = "jquery.min.js,bootstrap.min.js,autocomplete.jquery.min.js,prettify.min.js";
79 | /**
80 | * 内部依赖的所有css列表
81 | */
82 | String CSS_NAMES = "style.css,bootstrap.min.css,font-awesome.min.css,prettify.min.css";
83 | /**
84 | * 内部依赖的所有字体列表
85 | */
86 | String FONT_NAMES = "fontawesome-webfont.ttf,glyphicons-halflings-regular.ttf";
87 | /**
88 | * 缓存文件
89 | */
90 | String CACHE_FILE = ".cache.json";
91 | /**
92 | * 默认水印
93 | */
94 | String DEFAULT_WATERMARK = "doc-apis";
95 | /**
96 | * 默认密级
97 | */
98 | String DEFAULT_CLASSIFICATION_LEVEL = "II";
99 | }
100 |
--------------------------------------------------------------------------------
/doc-apis-starter/src/main/java/com/docapis/starter/config/AutoConfig.java:
--------------------------------------------------------------------------------
1 | package com.docapis.starter.config;
2 |
3 |
4 | import com.docapis.core.Docs;
5 | import com.docapis.core.DocsConfig;
6 | import com.docapis.core.LogUtils;
7 | import com.docapis.core.plugin.markdown.MarkdownDocPlugin;
8 | import com.docapis.starter.property.DocPlusConfigProperties;
9 | import org.springframework.beans.factory.InitializingBean;
10 | import org.springframework.beans.factory.annotation.Autowired;
11 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
12 | import org.springframework.boot.context.properties.EnableConfigurationProperties;
13 | import org.springframework.context.annotation.Configuration;
14 |
15 | import java.util.concurrent.CompletableFuture;
16 |
17 | /**
18 | * 自动生成装配
19 | *
20 | * Copyright © 2024 xpc1024 All Rights Reserved
21 | **/
22 | @Configuration
23 | @EnableConfigurationProperties(value = {DocPlusConfigProperties.class})
24 | @ConditionalOnProperty(prefix = "doc-apis", name = {"enable"}, havingValue = "true", matchIfMissing = true)
25 | public class AutoConfig implements InitializingBean {
26 | @Autowired
27 | private DocPlusConfigProperties docPlusConfigProperties;
28 |
29 | @Override
30 | public void afterPropertiesSet() throws Exception {
31 | if (!docPlusConfigProperties.isEnable()) {
32 | // 未开启, 直接不生成
33 | LogUtils.info("doc-apis not enabled, won't generate docs");
34 | return;
35 | }
36 | CompletableFuture.runAsync(this::doGenerate)
37 | .exceptionally(throwable -> {
38 | throwable.printStackTrace();
39 | return null;
40 | });
41 | }
42 |
43 | private void doGenerate() {
44 | DocsConfig config = new DocsConfig();
45 | // 项目根目录
46 | config.setProjectPath(docPlusConfigProperties.getProjectPath());
47 | // 项目名称
48 | config.setProjectName(docPlusConfigProperties.getProjectName());
49 | // 声明该API的版本
50 | config.setApiVersion(docPlusConfigProperties.getDocVersion());
51 | // 生成API 文档所在目录
52 | config.setDocsPath(docPlusConfigProperties.getDocPath());
53 | // 配置自动生成
54 | config.setAutoGenerate(docPlusConfigProperties.isAutoGenerate());
55 | // 添加MarkDown文档
56 | if (docPlusConfigProperties.isGenerateMarkDown()) {
57 | config.addPlugin(new MarkdownDocPlugin());
58 | }
59 |
60 | // 设置默认语言
61 | config.setLocale(docPlusConfigProperties.getLocale());
62 |
63 | // 执行生成文档
64 | Docs.buildHtmlDocs(config);
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/Resources.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core;
2 |
3 | import freemarker.template.Configuration;
4 | import freemarker.template.Template;
5 |
6 | import java.io.*;
7 |
8 | /**
9 | * resources
10 | *
11 | * licence Apache 2.0, from japidoc
12 | **/
13 | public class Resources {
14 |
15 | private static boolean isDebug = false;
16 | private static String debugResourcePath;
17 |
18 | static {
19 | try {
20 | if (!isDebug) {
21 | freemarker.log.Logger.selectLoggerLibrary(freemarker.log.Logger.LIBRARY_NONE);
22 | }
23 | } catch (ClassNotFoundException e) {
24 | e.printStackTrace();
25 | }
26 | }
27 |
28 | public static InputStream getTemplateFile(String fileName) throws FileNotFoundException {
29 |
30 | if (isDebug) {
31 | return new FileInputStream(new File(debugResourcePath, fileName));
32 | }
33 |
34 | final String userResPath = getUserResourcePath();
35 |
36 | if (getUserResourcePath() != null) {
37 | File tplFile = new File(userResPath, fileName);
38 | if (tplFile.isFile() && tplFile.exists()) {
39 | return new FileInputStream(tplFile);
40 | }
41 | }
42 |
43 | return Resources.class.getResourceAsStream("/" + fileName);
44 | }
45 |
46 | public static InputStream getCodeTemplateFile(String fileName) throws FileNotFoundException {
47 | return getTemplateFile(fileName);
48 | }
49 |
50 | public static Template getFreemarkerTemplate(String fileName) throws IOException {
51 | Configuration conf = new Configuration(Configuration.VERSION_2_3_0);
52 | conf.setDefaultEncoding("utf-8");
53 | if (isDebug) {
54 | conf.setDirectoryForTemplateLoading(new File(debugResourcePath));
55 | } else {
56 | final String userResPath = getUserResourcePath();
57 | File tplFile = new File(userResPath, fileName);
58 | if (tplFile.isFile() && tplFile.exists()) {
59 | conf.setDirectoryForTemplateLoading(new File(userResPath));
60 | } else {
61 | conf.setClassForTemplateLoading(Resources.class, "/");
62 | }
63 | }
64 | return conf.getTemplate(fileName);
65 | }
66 |
67 | private static String getUserResourcePath() {
68 | return DocContext.getDocsConfig().resourcePath;
69 | }
70 |
71 |
72 | public static void setDebug() {
73 | isDebug = true;
74 | debugResourcePath = System.getProperty("user.dir") + "/build/resources/main";
75 | }
76 | }
77 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/CacheUtils.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core;
2 |
3 |
4 | import com.docapis.core.parser.ClassNode;
5 | import com.docapis.core.parser.ControllerNode;
6 | import com.docapis.core.parser.ResponseNode;
7 |
8 | import java.io.File;
9 | import java.io.FileInputStream;
10 | import java.io.IOException;
11 | import java.util.Arrays;
12 | import java.util.List;
13 |
14 | import static com.docapis.core.constant.CoreConstants.CACHE_FILE;
15 |
16 | /**
17 | * abstract doc generator
18 | *
19 | * licence Apache 2.0,AGPL-3.0, from japidoc and doc-apis originated
20 | **/
21 | public class CacheUtils {
22 |
23 | public static void saveControllerNodes(List controllerNodes) {
24 | try {
25 | controllerNodes.forEach(controllerNode -> {
26 | controllerNode.getRequestNodes().forEach(requestNode -> {
27 | requestNode.setControllerNode(null);
28 | requestNode.setLastRequestNode(null);
29 | ResponseNode responseNode = requestNode.getResponseNode();
30 | responseNode.setRequestNode(null);
31 | removeLoopNode(responseNode);
32 | });
33 | });
34 | Utils.writeToDisk(new File(DocContext.getDocPath(), CACHE_FILE), Utils.toJson(controllerNodes));
35 | } catch (Exception ex) {
36 | LogUtils.error("saveControllerNodes error!!!", ex);
37 | }
38 | }
39 |
40 | private static void removeLoopNode(ClassNode classNode) {
41 | classNode.setParentNode(null);
42 | classNode.setGenericNodes(null);
43 | classNode.getChildNodes().forEach(fieldNode -> {
44 | fieldNode.setClassNode(null);
45 | if (fieldNode.getChildNode() != null) {
46 | removeLoopNode(fieldNode.getChildNode());
47 | }
48 | });
49 | }
50 |
51 | public static List getControllerNodes(String apiVersion) {
52 | File apiRootPath = new File(new File(DocContext.getDocPath()).getParentFile(), apiVersion);
53 | if (!apiRootPath.exists()) {
54 | return null;
55 | }
56 | File cacheFile = new File(apiRootPath, CACHE_FILE);
57 | if (!cacheFile.exists()) {
58 | return null;
59 | }
60 | try {
61 | ControllerNode[] controllerNodes = Utils.jsonToObject(Utils.streamToString(new FileInputStream(cacheFile)), ControllerNode[].class);
62 | return Arrays.asList(controllerNodes);
63 | } catch (IOException ex) {
64 | LogUtils.error("get ControllerNodes error!!!", ex);
65 | return null;
66 | }
67 | }
68 | }
69 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/CodeGenerator.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator;
2 |
3 |
4 | import com.docapis.core.DocContext;
5 | import com.docapis.core.Utils;
6 | import com.docapis.core.parser.ClassNode;
7 | import com.docapis.core.parser.FieldNode;
8 | import com.docapis.core.parser.ResponseNode;
9 |
10 | import java.io.File;
11 | import java.io.IOException;
12 |
13 | /**
14 | * code generator
15 | *
16 | * licence Apache 2.0, from japidoc
17 | **/
18 | public abstract class CodeGenerator {
19 |
20 | private ResponseNode responseNode;
21 | private File codePath;
22 | private String codeRelativePath;
23 |
24 | public CodeGenerator(ResponseNode responseNode) {
25 | this.responseNode = responseNode;
26 | this.codeRelativePath = getRelativeCodeDir();
27 | this.codePath = new File(DocContext.getDocPath(), codeRelativePath);
28 | if (!this.codePath.exists()) {
29 | this.codePath.mkdirs();
30 | }
31 | }
32 |
33 | public String generateCode() throws IOException {
34 | if (responseNode.getChildNodes() == null || responseNode.getChildNodes().isEmpty()) {
35 | return "";
36 | }
37 | StringBuilder codeBodyBuilder = new StringBuilder();
38 | generateCodeForBuilder(responseNode, codeBodyBuilder);
39 | final String sCodeTemplate = getCodeTemplate();
40 | CodeFileBuilder codeBuilder = new CodeFileBuilder(responseNode.getClassName(), codeBodyBuilder.toString(), sCodeTemplate);
41 | final String javaFileName = String.format("%s_%s_%s_%s.html",
42 | responseNode.getRequestNode().getControllerNode().getPackageName().replace(".", "_"),
43 | responseNode.getRequestNode().getControllerNode().getClassName(),
44 | responseNode.getRequestNode().getMethodName(), responseNode.getClassName());
45 | Utils.writeToDisk(new File(codePath, javaFileName), codeBuilder.build());
46 | return String.format("%s/%s", codeRelativePath, javaFileName);
47 | }
48 |
49 | private void generateCodeForBuilder(ClassNode rootNode, StringBuilder codeBodyBuilder) throws IOException {
50 | codeBodyBuilder.append(generateNodeCode(rootNode));
51 | codeBodyBuilder.append('\n');
52 | for (FieldNode recordNode : rootNode.getChildNodes()) {
53 | if (recordNode.getChildNode() != null) {
54 | generateCodeForBuilder(recordNode.getChildNode(), codeBodyBuilder);
55 | }
56 | }
57 | }
58 |
59 | public abstract String generateNodeCode(ClassNode classNode) throws IOException;
60 |
61 | public abstract String getRelativeCodeDir();
62 |
63 | public abstract String getCodeTemplate();
64 | }
65 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/provider/DocFieldHelper.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.provider;
2 |
3 |
4 | import com.docapis.core.Utils;
5 |
6 | /**
7 | * doc field helper
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | public class DocFieldHelper {
12 |
13 | public static String getPrefFieldName(String originFieldName) {
14 | String[] names = originFieldName.split("_");
15 | if (names.length == 1) {
16 | return Utils.decapitalize(names[0]);
17 | }
18 | StringBuilder fieldNameBuilder = new StringBuilder();
19 | fieldNameBuilder.append(Utils.decapitalize(names[0]));
20 | for (int i = 1; i < names.length; i++) {
21 | fieldNameBuilder.append(Utils.capitalize(names[i]));
22 | }
23 | return fieldNameBuilder.toString();
24 | }
25 |
26 | public static String getPrefFieldType(String fieldType) {
27 |
28 | if (fieldType == null) {
29 | return "unknow";
30 | }
31 |
32 | if (fieldType.equalsIgnoreCase("int") || fieldType.equalsIgnoreCase("integer")) {
33 | return "int";
34 | } else if (fieldType.equalsIgnoreCase("short")) {
35 | return "short";
36 | } else if (fieldType.equalsIgnoreCase("byte")) {
37 | return "byte";
38 | } else if (fieldType.equalsIgnoreCase("long")) {
39 | return "long";
40 | } else if (fieldType.equalsIgnoreCase("boolean") || fieldType.equalsIgnoreCase("bool")) {
41 | return "boolean";
42 | } else if (fieldType.equalsIgnoreCase("float")) {
43 | return "float";
44 | } else if (fieldType.equalsIgnoreCase("double")) {
45 | return "double";
46 | } else if (fieldType.equalsIgnoreCase("String") || fieldType.equalsIgnoreCase("Date")) {
47 | return "String";
48 | } else {
49 | return fieldType;
50 | }
51 | }
52 |
53 | public static String getIosFieldType(String type) {
54 | if (type.equals("byte")) {
55 | return "int";
56 | } else if (type.equals("int")) {
57 | return "NSInteger";
58 | } else if (type.equals("short")) {
59 | return "short";
60 | } else if (type.equals("long")) {
61 | return "long";
62 | } else if (type.equals("float")) {
63 | return "CGFloat";
64 | } else if (type.equals("double")) {
65 | return "double";
66 | } else if (type.equals("boolean")) {
67 | return "BOOL";
68 | } else if (type.equalsIgnoreCase("String")) {
69 | return "NSString";
70 | } else {
71 | return type;
72 | }
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/ControllerNode.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | import java.util.ArrayList;
4 | import java.util.List;
5 |
6 | /**
7 | * controller node
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | public class ControllerNode {
12 |
13 | private String author;
14 | private String description;
15 | private String baseUrl;
16 | private String className;
17 | private String packageName;
18 | private Boolean generateDocs = Boolean.FALSE;
19 | private List requestNodes = new ArrayList<>();
20 | private String srcFileName;
21 | private String docFileName;
22 |
23 | public String getPackageName() {
24 | return packageName;
25 | }
26 |
27 | public String getSrcFileName() {
28 | return srcFileName;
29 | }
30 |
31 | public void setSrcFileName(String srcFileName) {
32 | this.srcFileName = srcFileName;
33 | }
34 |
35 | public Boolean getGenerateDocs() {
36 | return generateDocs;
37 | }
38 |
39 | public void setGenerateDocs(Boolean generateDocs) {
40 | this.generateDocs = generateDocs;
41 | }
42 |
43 | public String getDocFileName() {
44 | return docFileName;
45 | }
46 |
47 | public void setDocFileName(String docFileName) {
48 | this.docFileName = docFileName;
49 | }
50 |
51 | public void setPackageName(String packageName) {
52 | this.packageName = packageName;
53 | }
54 |
55 | public String getAuthor() {
56 | return author;
57 | }
58 |
59 | public void setAuthor(String author) {
60 | this.author = author;
61 | }
62 |
63 | public String getDescription() {
64 | if (description != null) {
65 | description = description.replaceAll("\\r\\n", "");
66 | }
67 | return description;
68 | }
69 |
70 | public void setDescription(String description) {
71 | this.description = description;
72 | }
73 |
74 | public String getBaseUrl() {
75 | return baseUrl == null ? "" : baseUrl;
76 | }
77 |
78 | public void setBaseUrl(String baseUrl) {
79 | this.baseUrl = baseUrl;
80 | }
81 |
82 | public List getRequestNodes() {
83 | return requestNodes;
84 | }
85 |
86 | public void setRequestNodes(List requestNodes) {
87 | this.requestNodes = requestNodes;
88 | }
89 |
90 | public void addRequestNode(RequestNode requestNode) {
91 | requestNodes.add(requestNode);
92 | }
93 |
94 | public String getClassName() {
95 | return className;
96 | }
97 |
98 | public void setClassName(String className) {
99 | this.className = className;
100 | }
101 | }
102 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/doc/HtmlDocGenerator.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.doc;
2 |
3 | import com.docapis.core.DocContext;
4 | import com.docapis.core.LogUtils;
5 | import com.docapis.core.Resources;
6 | import com.docapis.core.Utils;
7 | import com.docapis.core.parser.ControllerNode;
8 | import com.docapis.core.parser.RequestNode;
9 | import freemarker.template.Template;
10 | import freemarker.template.TemplateException;
11 |
12 | import java.io.File;
13 | import java.io.FileWriter;
14 | import java.io.IOException;
15 | import java.util.HashMap;
16 | import java.util.List;
17 | import java.util.Map;
18 |
19 | import static com.docapis.core.constant.CoreConstants.*;
20 |
21 | /**
22 | * html doc generator
23 | *
24 | * licence Apache 2.0,AGPL-3.0, from japidoc and doc-apis originated
25 | **/
26 | public class HtmlDocGenerator extends AbsDocGenerator {
27 |
28 | public HtmlDocGenerator() {
29 | super(DocContext.controllerParser(), new HtmlControllerDocBuilder());
30 | }
31 |
32 | @Override
33 | void generateIndex(List controllerNodeList) {
34 | FileWriter docFileWriter = null;
35 | try {
36 | LogUtils.info("doc-apis generate index start !");
37 | final Template ctrlTemplate = getIndexTpl();
38 | final File docFile = new File(DocContext.getDocPath(), "index.html");
39 | docFileWriter = new FileWriter(docFile);
40 | Map data = new HashMap<>();
41 | controllerNodeList.forEach(controllerNode -> {
42 | List requestNodes = controllerNode.getRequestNodes();
43 | requestNodes.forEach(requestNode -> {
44 | String codeFileUrl = requestNode.getCodeFileUrl();
45 | requestNode.setCodeFileUrl(HTML_PATH + SEPATOR + codeFileUrl);
46 | });
47 | });
48 | data.put("controllerNodeList", controllerNodeList);
49 | data.put("currentApiVersion", DocContext.getCurrentApiVersion());
50 | data.put("apiVersionList", DocContext.getApiVersionList());
51 | data.put("projectName", DocContext.getDocsConfig().getProjectName());
52 | data.put("i18n", DocContext.getI18n());
53 | data.put("watermark", DocContext.getDocsConfig().getWatermark());
54 | data.put("classificationLevel", DocContext.getDocsConfig().getClassificationLevel());
55 | ctrlTemplate.process(data, docFileWriter);
56 | LogUtils.info("doc-apis generate index success !");
57 | } catch (TemplateException | IOException ex) {
58 | LogUtils.error("doc-apis generate index fail !", ex);
59 | } finally {
60 | Utils.closeSilently(docFileWriter);
61 | }
62 | }
63 |
64 | private Template getIndexTpl() throws IOException {
65 | return Resources.getFreemarkerTemplate("api-index.html.ftl");
66 | }
67 | }
68 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/ios/ModelCodeGenerator.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.ios;
2 |
3 |
4 | import com.docapis.core.codegenerator.CodeGenerator;
5 | import com.docapis.core.codegenerator.IFieldProvider;
6 | import com.docapis.core.codegenerator.TemplateProvider;
7 | import com.docapis.core.codegenerator.ios.builder.ModelBuilder;
8 | import com.docapis.core.codegenerator.ios.builder.ModelFieldBuilder;
9 | import com.docapis.core.codegenerator.model.FieldModel;
10 | import com.docapis.core.codegenerator.provider.ProviderFactory;
11 | import com.docapis.core.parser.ClassNode;
12 | import com.docapis.core.parser.ResponseNode;
13 |
14 | import java.io.IOException;
15 | import java.util.List;
16 |
17 | /**
18 | * 模型构造
19 | *
20 | * licence Apache 2.0, from japidoc
21 | **/
22 | public class ModelCodeGenerator extends CodeGenerator {
23 |
24 | private static final String FILE_FIELD_TEMPLATE = "IOS_Model_Field.tpl";
25 | private static final String FILE_MODEL_TEMPLATE = "IOS_Model.tpl";
26 | private static final String FILE_CODE_TEMPLATE = "Code_File.html.tpl";
27 | private static final String IOS_CODE_DIR = "iosCodes";
28 |
29 | private static String sFieldTemplate;
30 | private static String sModelTemplate;
31 | private static String sCodeTemplate;
32 |
33 | static {
34 | ModelTemplateProvider resourceTemplateProvider = new ModelTemplateProvider();
35 | try {
36 | sFieldTemplate = resourceTemplateProvider.provideTemplateForName(FILE_FIELD_TEMPLATE);
37 | sModelTemplate = resourceTemplateProvider.provideTemplateForName(FILE_MODEL_TEMPLATE);
38 | sCodeTemplate = TemplateProvider.provideTemplateForName(FILE_CODE_TEMPLATE);
39 | } catch (IOException e) {
40 | e.printStackTrace();
41 | }
42 | }
43 |
44 | public ModelCodeGenerator(ResponseNode responseNode) {
45 | super(responseNode);
46 | }
47 |
48 | @Override
49 | public String generateNodeCode(ClassNode respNode) throws IOException {
50 | String className = respNode.getClassName();
51 | IFieldProvider entryProvider = ProviderFactory.createProvider();
52 | List entryFields = entryProvider.provideFields(respNode);
53 | if (entryFields == null || entryFields.isEmpty()) {
54 | return "";
55 | }
56 | StringBuilder fieldStrings = new StringBuilder();
57 | for (FieldModel entryFieldModel : entryFields) {
58 | ModelFieldBuilder fieldBuilder = new ModelFieldBuilder(sFieldTemplate, entryFieldModel);
59 | fieldStrings.append(fieldBuilder.build());
60 | }
61 | ModelBuilder modelBuilder = new ModelBuilder(sModelTemplate, className, fieldStrings.toString());
62 | return modelBuilder.build();
63 | }
64 |
65 | @Override
66 | public String getRelativeCodeDir() {
67 | return IOS_CODE_DIR;
68 | }
69 |
70 | @Override
71 | public String getCodeTemplate() {
72 | return sCodeTemplate;
73 | }
74 | }
75 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/http/DHttpUtils.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.http;
2 |
3 | import java.io.IOException;
4 | import java.io.OutputStreamWriter;
5 | import java.net.HttpURLConnection;
6 | import java.net.URL;
7 | import java.net.URLEncoder;
8 | import java.util.Iterator;
9 | import java.util.Map;
10 |
11 | /**
12 | * http utils
13 | *
14 | * licence Apache 2.0, from japidoc
15 | **/
16 | public class DHttpUtils {
17 |
18 | private DHttpUtils() {
19 |
20 | }
21 |
22 | public static DHttpResponse httpPost(DHttpRequest request) throws IOException {
23 |
24 | URL url = new URL(request.getUrl());
25 | HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
26 | httpConn.setRequestMethod("POST");
27 | httpConn.setInstanceFollowRedirects(request.isAutoRedirect());
28 |
29 | Map headers = request.getHeaders();
30 | if (headers != null) {
31 | for (Map.Entry headerEntry : headers.entrySet()) {
32 | httpConn.addRequestProperty(headerEntry.getKey(), headerEntry.getValue());
33 | }
34 | }
35 |
36 | StringBuffer requestParams = new StringBuffer();
37 | Map params = request.getParams();
38 | if (params != null && params.size() > 0) {
39 | httpConn.setDoOutput(true);
40 |
41 | Iterator paramIterator = params.keySet().iterator();
42 | while (paramIterator.hasNext()) {
43 | String key = paramIterator.next();
44 | String value = params.get(key);
45 | requestParams.append(URLEncoder.encode(key, "UTF-8"));
46 | requestParams.append("=").append(
47 | URLEncoder.encode(value, "UTF-8"));
48 | requestParams.append("&");
49 | }
50 |
51 | // sends POST data
52 | OutputStreamWriter writer = new OutputStreamWriter(
53 | httpConn.getOutputStream());
54 | writer.write(requestParams.toString());
55 | writer.flush();
56 | }
57 |
58 |
59 | return toResponse(httpConn);
60 | }
61 |
62 | public static DHttpResponse httpGet(String requestURL) throws IOException {
63 | URL url = new URL(requestURL);
64 | HttpURLConnection httpConn = (HttpURLConnection) url.openConnection();
65 | httpConn.setDoOutput(true);
66 | httpConn.setRequestMethod("GET");
67 | return toResponse(httpConn);
68 | }
69 |
70 | private static DHttpResponse toResponse(HttpURLConnection httpConn) throws IOException {
71 | DHttpResponse response = new DHttpResponse();
72 | response.setCode(httpConn.getResponseCode());
73 | response.setStream(httpConn.getInputStream());
74 | for (int i = 0, size = httpConn.getHeaderFields().size(); i != size; i++) {
75 | response.addHeader(httpConn.getHeaderFieldKey(i), httpConn.getHeaderField(i));
76 | }
77 | return response;
78 | }
79 | }
80 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/plugin/rap/Action.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.plugin.rap;
2 |
3 | import java.util.HashSet;
4 | import java.util.Set;
5 |
6 | /**
7 | * action
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | class Action {
12 |
13 | private int id;
14 | private int disableCache;
15 | private String name;
16 | private String description;
17 | private String requestType = "1";
18 | private String requestUrl;
19 | private Set requestParameterList = new HashSet();
20 | private Set responseParameterList = new HashSet();
21 | private String responseTemplate;
22 | private Set pageList = new HashSet();
23 | private String remarks;
24 |
25 | public static Action newAction() {
26 | Action action = new Action();
27 | action.setId(-1);
28 | return action;
29 | }
30 |
31 | public int getId() {
32 | return id;
33 | }
34 |
35 | public void setId(int id) {
36 | this.id = id;
37 | }
38 |
39 | public int getDisableCache() {
40 | return disableCache;
41 | }
42 |
43 | public void setDisableCache(int disableCache) {
44 | this.disableCache = disableCache;
45 | }
46 |
47 | public String getName() {
48 | return name;
49 | }
50 |
51 | public void setName(String name) {
52 | this.name = name;
53 | }
54 |
55 | public String getDescription() {
56 | return description;
57 | }
58 |
59 | public void setDescription(String description) {
60 | this.description = description;
61 | }
62 |
63 | public String getRequestType() {
64 | return requestType;
65 | }
66 |
67 | public void setRequestType(String requestType) {
68 | this.requestType = requestType;
69 | }
70 |
71 | public String getRequestUrl() {
72 | return requestUrl;
73 | }
74 |
75 | public void setRequestUrl(String requestUrl) {
76 | this.requestUrl = requestUrl;
77 | }
78 |
79 | public Set getRequestParameterList() {
80 | return requestParameterList;
81 | }
82 |
83 | public void setRequestParameterList(Set requestParameterList) {
84 | this.requestParameterList = requestParameterList;
85 | }
86 |
87 | public Set getResponseParameterList() {
88 | return responseParameterList;
89 | }
90 |
91 | public void setResponseParameterList(Set responseParameterList) {
92 | this.responseParameterList = responseParameterList;
93 | }
94 |
95 | public String getResponseTemplate() {
96 | return responseTemplate;
97 | }
98 |
99 | public void setResponseTemplate(String responseTemplate) {
100 | this.responseTemplate = responseTemplate;
101 | }
102 |
103 | public Set getPageList() {
104 | return pageList;
105 | }
106 |
107 | public void setPageList(Set pageList) {
108 | this.pageList = pageList;
109 | }
110 |
111 | public String getRemarks() {
112 | return remarks;
113 | }
114 |
115 | public void setRemarks(String remarks) {
116 | this.remarks = remarks;
117 | }
118 | }
119 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/Docs.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core;
2 |
3 | import com.docapis.core.doc.HtmlDocGenerator;
4 | import com.docapis.core.plugin.rap.RapSupportPlugin;
5 |
6 | import java.io.File;
7 | import java.io.FileReader;
8 | import java.io.IOException;
9 | import java.util.Properties;
10 |
11 | import static com.docapis.core.constant.CoreConstants.*;
12 |
13 | /**
14 | * docs
15 | *
16 | * licence Apache 2.0,AGPL-3.0, from japidoc and doc-apis originated
17 | **/
18 | public class Docs {
19 |
20 | private static final String CONFIG_FILE = "docs.config";
21 |
22 | public static void main(String[] args) {
23 | DocsConfig config = loadProps();
24 | buildHtmlDocs(config);
25 | }
26 |
27 | public static void buildHtmlDocs(DocsConfig config) {
28 | DocContext.init(config);
29 | HtmlDocGenerator docGenerator = new HtmlDocGenerator();
30 | DocContext.setControllerNodeList(docGenerator.getControllerNodeList());
31 | try {
32 | docGenerator.generateDocs();
33 | } catch (Throwable e) {
34 | e.printStackTrace();
35 | } finally {
36 | // 清理可能产生的PageInfo临时文件
37 | Utils.deleteFileWithRetry(System.getProperty(USER_DIR) + File.separator + PAGE_INFO_FILE);
38 | Utils.deleteFileWithRetry(System.getProperty(USER_DIR) + File.separator + ES_PAGE_INFO_FILE);
39 | }
40 | CacheUtils.saveControllerNodes(docGenerator.getControllerNodeList());
41 | DocsConfig docsConfig = DocContext.getDocsConfig();
42 | if (docsConfig.getRapProjectId() != null && docsConfig.getRapHost() != null) {
43 | IPluginSupport rapPlugin = new RapSupportPlugin();
44 | rapPlugin.execute(docGenerator.getControllerNodeList());
45 | }
46 | for (IPluginSupport plugin : config.getPlugins()) {
47 | plugin.execute(docGenerator.getControllerNodeList());
48 | }
49 |
50 | // 清理 cache.json
51 | Utils.deleteFileWithRetry(DocContext.getDocPath() + File.separator + CACHE_FILE);
52 | }
53 |
54 | public static void setResponseWrapper(IResponseWrapper responseWrapper) {
55 | DocContext.setResponseWrapper(responseWrapper);
56 | }
57 |
58 | private static DocsConfig loadProps() {
59 | try {
60 | Properties properties = new Properties();
61 | properties.load(new FileReader(CONFIG_FILE));
62 | DocsConfig config = new DocsConfig();
63 | config.projectPath = properties.getProperty("projectPath", null);
64 |
65 | if (config.projectPath == null) {
66 | throw new RuntimeException("projectPath property is needed in the config file.");
67 | }
68 |
69 | config.docsPath = properties.getProperty("docsPath", null);
70 | config.resourcePath = properties.getProperty("resourcePath", null);
71 | config.mvcFramework = properties.getProperty("mvcFramework", "");
72 | return config;
73 | } catch (IOException e) {
74 | e.printStackTrace();
75 |
76 | try {
77 | File configFile = new File(CONFIG_FILE);
78 | configFile.createNewFile();
79 | } catch (Exception ex) {
80 | e.printStackTrace();
81 | }
82 |
83 | throw new RuntimeException("you need to set projectPath property in " + CONFIG_FILE);
84 | }
85 | }
86 | }
87 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/doc/HtmlControllerDocBuilder.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.doc;
2 |
3 | import com.docapis.core.DocContext;
4 | import com.docapis.core.LogUtils;
5 | import com.docapis.core.Resources;
6 | import com.docapis.core.Utils;
7 | import com.docapis.core.codegenerator.ios.ModelCodeGenerator;
8 | import com.docapis.core.codegenerator.java.JavaCodeGenerator;
9 | import com.docapis.core.parser.ControllerNode;
10 | import com.docapis.core.parser.RequestNode;
11 | import freemarker.template.Template;
12 | import freemarker.template.TemplateException;
13 |
14 | import java.io.File;
15 | import java.io.FileInputStream;
16 | import java.io.FileWriter;
17 | import java.io.IOException;
18 | import java.util.HashMap;
19 | import java.util.Map;
20 |
21 | import static com.docapis.core.constant.CoreConstants.HTML_PATH;
22 |
23 | /**
24 | * html controller doc builder
25 | *
26 | * licence Apache 2.0,AGPL-3.0, from japidoc and doc-apis originated
27 | **/
28 | public class HtmlControllerDocBuilder implements IControllerDocBuilder {
29 |
30 | @Override
31 | public String buildDoc(ControllerNode controllerNode) throws IOException {
32 |
33 | for (RequestNode requestNode : controllerNode.getRequestNodes()) {
34 | if (requestNode.getResponseNode() != null && !requestNode.getResponseNode().getChildNodes().isEmpty()) {
35 | JavaCodeGenerator javaCodeGenerator = new JavaCodeGenerator(requestNode.getResponseNode());
36 | final String javaSrcUrl = javaCodeGenerator.generateCode();
37 | requestNode.setAndroidCodePath(javaSrcUrl);
38 | ModelCodeGenerator iosCodeGenerator = new ModelCodeGenerator(requestNode.getResponseNode());
39 | final String iosSrcUrl = iosCodeGenerator.generateCode();
40 | requestNode.setIosCodePath(iosSrcUrl);
41 | }
42 | }
43 |
44 | final Template ctrlTemplate = getControllerTpl();
45 | String path = DocContext.getDocPath() + File.separator + HTML_PATH;
46 | File htmlDir = new File(path);
47 | if (!htmlDir.exists()) {
48 | boolean mkdir = htmlDir.mkdir();
49 | if (!mkdir) {
50 | LogUtils.error("create html docs dir fail");
51 | }
52 | }
53 | final File docFile = new File(path, controllerNode.getDocFileName());
54 | FileWriter docFileWriter = new FileWriter(docFile);
55 | Map data = new HashMap<>();
56 | data.put("controllerNodeList", DocContext.getControllerNodeList());
57 | data.put("controller", controllerNode);
58 | data.put("currentApiVersion", DocContext.getCurrentApiVersion());
59 | data.put("apiVersionList", DocContext.getApiVersionList());
60 | data.put("projectName", DocContext.getDocsConfig().getProjectName());
61 | data.put("i18n", DocContext.getI18n());
62 | data.put("watermark", DocContext.getDocsConfig().getWatermark());
63 | data.put("classificationLevel", DocContext.getDocsConfig().getWatermark());
64 | try {
65 | ctrlTemplate.process(data, docFileWriter);
66 | } catch (TemplateException ex) {
67 | ex.printStackTrace();
68 | } finally {
69 | Utils.closeSilently(docFileWriter);
70 | }
71 | return Utils.streamToString(new FileInputStream(docFile));
72 | }
73 |
74 | private Template getControllerTpl() throws IOException {
75 | return Resources.getFreemarkerTemplate("api-controller.html.ftl");
76 | }
77 |
78 | }
79 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/plugin/rap/Parameter.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.plugin.rap;
2 |
3 | import java.util.HashSet;
4 | import java.util.Set;
5 |
6 | /**
7 | * parameter
8 | *
9 | * licence Apache 2.0, from japidoc
10 | **/
11 | class Parameter {
12 |
13 | private int id;
14 | private String mockData;
15 | private String name;
16 | private String identifier;
17 | private String identifierChange;
18 | private String remarkChange;
19 | private String dataType;
20 | private String remark;
21 | private Set actionRequestList = new HashSet();
22 | private Set actionResponseList = new HashSet();
23 | private String validator = "";
24 | private Set parameterList = new HashSet();
25 | private Set complexParamerterList = new HashSet();
26 |
27 | public static Parameter newParameter() {
28 | Parameter p = new Parameter();
29 | p.setId(-1);
30 | return p;
31 | }
32 |
33 | public int getId() {
34 | return id;
35 | }
36 |
37 | public void setId(int id) {
38 | this.id = id;
39 | }
40 |
41 | public String getMockData() {
42 | return mockData;
43 | }
44 |
45 | public void setMockData(String mockData) {
46 | this.mockData = mockData;
47 | }
48 |
49 | public String getName() {
50 | return name;
51 | }
52 |
53 | public void setName(String name) {
54 | this.name = name;
55 | }
56 |
57 | public String getIdentifier() {
58 | return identifier;
59 | }
60 |
61 | public void setIdentifier(String identifier) {
62 | this.identifier = identifier;
63 | }
64 |
65 | public String getIdentifierChange() {
66 | return identifierChange;
67 | }
68 |
69 | public void setIdentifierChange(String identifierChange) {
70 | this.identifierChange = identifierChange;
71 | }
72 |
73 | public String getRemarkChange() {
74 | return remarkChange;
75 | }
76 |
77 | public void setRemarkChange(String remarkChange) {
78 | this.remarkChange = remarkChange;
79 | }
80 |
81 | public String getDataType() {
82 | return dataType;
83 | }
84 |
85 | public void setDataType(String dataType) {
86 | this.dataType = dataType;
87 | }
88 |
89 | public String getRemark() {
90 | return remark;
91 | }
92 |
93 | public void setRemark(String remark) {
94 | this.remark = remark;
95 | }
96 |
97 | public Set getActionRequestList() {
98 | return actionRequestList;
99 | }
100 |
101 | public void setActionRequestList(Set actionRequestList) {
102 | this.actionRequestList = actionRequestList;
103 | }
104 |
105 | public Set getActionResponseList() {
106 | return actionResponseList;
107 | }
108 |
109 | public void setActionResponseList(Set actionResponseList) {
110 | this.actionResponseList = actionResponseList;
111 | }
112 |
113 | public String getValidator() {
114 | return validator;
115 | }
116 |
117 | public void setValidator(String validator) {
118 | this.validator = validator;
119 | }
120 |
121 | public Set getParameterList() {
122 | return parameterList;
123 | }
124 |
125 | public void setParameterList(Set parameterList) {
126 | this.parameterList = parameterList;
127 | }
128 |
129 | public Set getComplexParamerterList() {
130 | return complexParamerterList;
131 | }
132 |
133 | public void setComplexParamerterList(Set complexParamerterList) {
134 | this.complexParamerterList = complexParamerterList;
135 | }
136 | }
137 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/parser/PlayRoutesParser.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.parser;
2 |
3 | import com.docapis.core.DocContext;
4 | import com.docapis.core.LogUtils;
5 | import com.docapis.core.Utils;
6 |
7 | import java.io.BufferedReader;
8 | import java.io.File;
9 | import java.io.FileReader;
10 | import java.io.IOException;
11 | import java.util.ArrayList;
12 | import java.util.List;
13 | import java.util.Optional;
14 |
15 | /**
16 | * play routes parser
17 | *
18 | * licence Apache 2.0, from japidoc
19 | **/
20 | public class PlayRoutesParser {
21 |
22 | private String routeFile;
23 | private String javaSrcPath;
24 |
25 | private List routeNodeList = new ArrayList<>();
26 |
27 | private PlayRoutesParser() {
28 | this.routeFile = DocContext.getProjectPath().concat("conf/routes");
29 | javaSrcPath = DocContext.getJavaSrcPaths().get(0);
30 | parse();
31 | }
32 |
33 | public static PlayRoutesParser INSTANCE = new PlayRoutesParser();
34 |
35 | private void parse() {
36 | BufferedReader reader = null;
37 | try {
38 | reader = new BufferedReader(new FileReader(new File(routeFile)));
39 | String lineText;
40 | String[] nodes;
41 | while ((lineText = reader.readLine()) != null) {
42 | lineText = lineText.trim();
43 | if (!Utils.isNotEmpty(lineText) || lineText.startsWith("#")) {
44 | continue;
45 | }
46 | nodes = lineText.split("\\s+");
47 | if (nodes.length < 3 || nodes[2].matches("\\d+")) {
48 | continue;
49 | }
50 |
51 | String[] actions = nodes[2].split("\\.");
52 | if (actions.length == 1) {
53 | continue;
54 | }
55 |
56 | StringBuilder ctrlPathBuilder = new StringBuilder();
57 | ctrlPathBuilder.append("controllers");
58 | for (int i = 0; i != actions.length - 1; i++) {
59 | ctrlPathBuilder.append('/');
60 | ctrlPathBuilder.append(actions[i]);
61 | }
62 |
63 | String controllerFileName = getControllerFile(ctrlPathBuilder.toString());
64 | if (!new File(controllerFileName).exists()) {
65 | continue;
66 | }
67 |
68 | RouteNode routeNode = new RouteNode(nodes[0].trim(), nodes[1].trim(), controllerFileName, actions[actions.length - 1]);
69 |
70 | routeNodeList.add(routeNode);
71 | }
72 | } catch (IOException e) {
73 | LogUtils.error("parse Play Routes Error", e);
74 | } finally {
75 | Utils.closeSilently(reader);
76 | }
77 | }
78 |
79 | public RouteNode getRouteNode(File controllerFile, String methodName) {
80 | Optional routeNode = routeNodeList.stream().filter(node -> controllerFile.getAbsolutePath().equals(node.controllerFile) && node.actionMethod.equals(methodName)).findFirst();
81 | return routeNode.isPresent() ? routeNode.get() : null;
82 | }
83 |
84 | public List getRouteNodeList() {
85 | return routeNodeList;
86 | }
87 |
88 | private String getControllerFile(String relativePath) {
89 | return javaSrcPath + relativePath + ".java";
90 | }
91 |
92 | public static class RouteNode {
93 | public final String method;
94 | public final String routeUrl;
95 | public final String controllerFile;
96 | public final String actionMethod;
97 |
98 | public RouteNode(String method, String routeUrl, String controllerFile, String actionMethod) {
99 | this.method = method;
100 | this.routeUrl = routeUrl;
101 | this.controllerFile = controllerFile;
102 | this.actionMethod = actionMethod;
103 | }
104 | }
105 | }
106 |
--------------------------------------------------------------------------------
/doc-apis-starter/src/main/java/com/docapis/starter/property/DocPlusConfigProperties.java:
--------------------------------------------------------------------------------
1 | package com.docapis.starter.property;
2 |
3 | import com.docapis.core.constant.CoreConstants;
4 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
5 | import org.springframework.boot.context.properties.ConfigurationProperties;
6 | import org.springframework.boot.context.properties.NestedConfigurationProperty;
7 |
8 | import java.util.Locale;
9 |
10 | /**
11 | * 配置
12 | *
13 | * Copyright © 2024 xpc1024 All Rights Reserved
14 | **/
15 | @ConfigurationProperties(value = "doc-apis")
16 | @ConditionalOnProperty(prefix = "doc-apis", name = {"enable"}, havingValue = "true", matchIfMissing = true)
17 | public class DocPlusConfigProperties {
18 | /**
19 | * 是否开启文档自动生成 默认开启
20 | */
21 | private boolean enable = true;
22 | /**
23 | * 项目名称
24 | */
25 | private String projectName = "doc-apis";
26 | /**
27 | * 项目路径
28 | */
29 | private String projectPath = System.getProperty(CoreConstants.USER_DIR);
30 | /**
31 | * 文档版本
32 | */
33 | private String docVersion = "doc-version-" + CoreConstants.VERSION;
34 | /**
35 | * 文档生成路径
36 | */
37 | private String docPath = System.getProperty(CoreConstants.USER_DIR);
38 | /**
39 | * 是否自动生成 默认为true 若为false时,需要加@DocApi注解
40 | */
41 | private boolean autoGenerate = true;
42 | /**
43 | * 是否生成markdown文档,默认生成,若为否则仅生成html文档
44 | */
45 | private boolean generateMarkDown = true;
46 | /**
47 | * 水印
48 | */
49 | private String watermark;
50 | /**
51 | * 接口文档密级
52 | */
53 | private String classificationLevel;
54 |
55 | /**
56 | * 跨域相关配置
57 | */
58 | @NestedConfigurationProperty
59 | private CorsConfigProperties corsConfig = new CorsConfigProperties();
60 |
61 | /**
62 | * 生成文档语言,默认为当前系统语言
63 | */
64 | private Locale locale = Locale.getDefault();
65 |
66 | public boolean isEnable() {
67 | return enable;
68 | }
69 |
70 | public void setEnable(boolean enable) {
71 | this.enable = enable;
72 | }
73 |
74 | public String getProjectName() {
75 | return projectName;
76 | }
77 |
78 | public void setProjectName(String projectName) {
79 | this.projectName = projectName;
80 | }
81 |
82 | public String getProjectPath() {
83 | return projectPath;
84 | }
85 |
86 | public void setProjectPath(String projectPath) {
87 | this.projectPath = projectPath;
88 | }
89 |
90 | public String getDocVersion() {
91 | return docVersion;
92 | }
93 |
94 | public void setDocVersion(String docVersion) {
95 | this.docVersion = docVersion;
96 | }
97 |
98 | public String getDocPath() {
99 | return docPath;
100 | }
101 |
102 | public void setDocPath(String docPath) {
103 | this.docPath = docPath;
104 | }
105 |
106 | public boolean isAutoGenerate() {
107 | return autoGenerate;
108 | }
109 |
110 | public void setAutoGenerate(boolean autoGenerate) {
111 | this.autoGenerate = autoGenerate;
112 | }
113 |
114 | public boolean isGenerateMarkDown() {
115 | return generateMarkDown;
116 | }
117 |
118 | public void setGenerateMarkDown(boolean generateMarkDown) {
119 | this.generateMarkDown = generateMarkDown;
120 | }
121 |
122 | public CorsConfigProperties getCorsConfig() {
123 | return corsConfig;
124 | }
125 |
126 | public Locale getLocale() {
127 | return locale;
128 | }
129 |
130 | public void setLocale(Locale locale) {
131 | this.locale = locale;
132 | }
133 |
134 | public String getWatermark() {
135 | return watermark;
136 | }
137 |
138 | public void setWatermark(String watermark) {
139 | this.watermark = watermark;
140 | }
141 |
142 | public String getClassificationLevel() {
143 | return classificationLevel;
144 | }
145 |
146 | public void setClassificationLevel(String classificationLevel) {
147 | this.classificationLevel = classificationLevel;
148 | }
149 |
150 | public void setCorsConfig(CorsConfigProperties corsConfig) {
151 | this.corsConfig = corsConfig;
152 | }
153 | }
154 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/codegenerator/java/JavaCodeGenerator.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.codegenerator.java;
2 |
3 |
4 | import com.docapis.core.codegenerator.CodeGenerator;
5 | import com.docapis.core.codegenerator.IFieldProvider;
6 | import com.docapis.core.codegenerator.TemplateProvider;
7 | import com.docapis.core.codegenerator.java.builder.JavaClassBuilder;
8 | import com.docapis.core.codegenerator.java.builder.JavaFieldBuilder;
9 | import com.docapis.core.codegenerator.java.builder.JavaGetterBuilder;
10 | import com.docapis.core.codegenerator.java.builder.JavaSetterBuilder;
11 | import com.docapis.core.codegenerator.model.FieldModel;
12 | import com.docapis.core.codegenerator.provider.ProviderFactory;
13 | import com.docapis.core.parser.ClassNode;
14 | import com.docapis.core.parser.ResponseNode;
15 |
16 | import java.io.IOException;
17 | import java.util.List;
18 |
19 | /**
20 | * java code generator
21 | *
22 | * licence Apache 2.0, from japidoc
23 | **/
24 | public class JavaCodeGenerator extends CodeGenerator {
25 |
26 | private static final String FILE_FIELD_TEMPLATE = "Java_Entity_Field.tpl";
27 | private static final String FILE_GETTER_TEMPLATE = "Java_Entity_Getter.tpl";
28 | private static final String FILE_SETTER_TEMPLATE = "Java_Entity_Setter.tpl";
29 | private static final String FILE_CLASS_TEMPLATE = "Java_Entity.tpl";
30 | private static final String FILE_CODE_TEMPLATE = "Code_File.html.tpl";
31 | private static final String JAVA_CODE_DIR = "javaCodes";
32 |
33 | private static String sFieldTemplate, sGetterTemplate, sSetterTemplate, sClassTemplate, sCodeTemplate;
34 |
35 | static {
36 | JavaTemplateProvider resourceTemplateProvider = new JavaTemplateProvider();
37 | try {
38 | sFieldTemplate = resourceTemplateProvider.provideTemplateForName(FILE_FIELD_TEMPLATE);
39 | sGetterTemplate = resourceTemplateProvider.provideTemplateForName(FILE_GETTER_TEMPLATE);
40 | sSetterTemplate = resourceTemplateProvider.provideTemplateForName(FILE_SETTER_TEMPLATE);
41 | sClassTemplate = resourceTemplateProvider.provideTemplateForName(FILE_CLASS_TEMPLATE);
42 | sCodeTemplate = TemplateProvider.provideTemplateForName(FILE_CODE_TEMPLATE);
43 | } catch (IOException e) {
44 | e.printStackTrace();
45 | }
46 | }
47 |
48 | public JavaCodeGenerator(ResponseNode responseNode) {
49 | super(responseNode);
50 | }
51 |
52 | @Override
53 | public String generateNodeCode(ClassNode respNode) throws IOException {
54 | String className = respNode.getClassName();
55 |
56 | IFieldProvider entryProvider = ProviderFactory.createProvider();
57 | List entryFields = entryProvider.provideFields(respNode);
58 |
59 | if (entryFields == null || entryFields.isEmpty()) {
60 | return "";
61 | }
62 |
63 | StringBuilder fieldStrings = new StringBuilder();
64 | StringBuilder methodStrings = new StringBuilder();
65 |
66 | String fieldTemplate = sFieldTemplate;
67 | String getterTemplate = sGetterTemplate;
68 | String setterTemplate = sSetterTemplate;
69 | String classTemplate = sClassTemplate;
70 |
71 | for (FieldModel entryFieldModel : entryFields) {
72 | JavaFieldBuilder fieldBuilder = new JavaFieldBuilder(fieldTemplate, entryFieldModel);
73 | fieldStrings.append(fieldBuilder.build());
74 | JavaGetterBuilder getterBuilder = new JavaGetterBuilder(getterTemplate, entryFieldModel);
75 | methodStrings.append(getterBuilder.build());
76 | JavaSetterBuilder setterBuilder = new JavaSetterBuilder(setterTemplate, entryFieldModel);
77 | methodStrings.append(setterBuilder.build());
78 | }
79 |
80 | if (methodStrings.charAt(methodStrings.length() - 1) == '\n') {
81 | methodStrings.deleteCharAt(methodStrings.length() - 1);
82 | }
83 |
84 | JavaClassBuilder classBuilder = new JavaClassBuilder(classTemplate, className, fieldStrings.toString(),
85 | methodStrings.toString());
86 | return classBuilder.build();
87 | }
88 |
89 | @Override
90 | public String getRelativeCodeDir() {
91 | return JAVA_CODE_DIR;
92 | }
93 |
94 | @Override
95 | public String getCodeTemplate() {
96 | return sCodeTemplate;
97 | }
98 | }
99 |
--------------------------------------------------------------------------------
/doc-apis-core/src/main/java/com/docapis/core/plugin/rap/DataType.java:
--------------------------------------------------------------------------------
1 | package com.docapis.core.plugin.rap;
2 |
3 | /**
4 | * data type
5 | *
6 | * licence Apache 2.0, from japidoc
7 | **/
8 | class DataType {
9 |
10 | public static String STRING = "string";
11 | public static String NUMBER = "number";
12 | public static String BOOLEAN = "boolean";
13 | public static String OBJECT = "object";
14 | public static String ARRAY = "array";
15 | public static String ARRAY_NUMBER = "array";
16 | public static String ARRAY_STRING = "array";
17 | public static String ARRAY_BOOLEAN = "array";
18 | public static String ARRAY_OBJECT = "array