Skip to content

GitLab

A
apidoc
Commit ca53f41f authored by duanledexianxianxian's avatar duanledexianxianxian 😁
Browse files
Options

代码重构

parent d1cdf8f4
Hide whitespace changes
Inline Side-by-side
Showing with 719 additions and 648 deletions
apidoc-core/src/main/java/com/kim/apidoc/core/ApiDoc.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/ApiDoc.java
View file @ ca53f41f
package com.kim.apidoc.core;
import com.kim.apidoc.core.common.helper.StringHelper;
import com.kim.apidoc.core.parser.ParserStrategy;
import com.kim.apidoc.core.parser.VisitorParser;
import com.kim.apidoc.core.render.ProjectRender;
import com.kim.apidoc.core.resolver.TypeResolvers;
import com.kim.apidoc.core.schema.Project;
package com.github.fengyuchenglun.apidoc.core;
import com.github.fengyuchenglun.apidoc.core.common.helper.StringHelper;
import com.github.fengyuchenglun.apidoc.core.parser.ParserStrategy;
import com.github.fengyuchenglun.apidoc.core.parser.VisitorParser;
import com.github.fengyuchenglun.apidoc.core.render.ProjectRender;
import com.github.fengyuchenglun.apidoc.core.resolver.TypeResolvers;
import com.github.fengyuchenglun.apidoc.core.schema.Project;
import com.github.javaparser.ParseResult;
import com.github.javaparser.ParserConfiguration;
import com.github.javaparser.ast.CompilationUnit;
......
apidoc-core/src/main/java/com/kim/apidoc/core/Context.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/Context.java
View file @ ca53f41f
package com.kim.apidoc.core;
package com.github.fengyuchenglun.apidoc.core;
import com.github.fengyuchenglun.apidoc.core.common.Constants;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.kim.apidoc.core.common.helper.FileHelper;
import com.kim.apidoc.core.render.MarkdownRender;
import com.kim.apidoc.core.render.ProjectRender;
import com.github.fengyuchenglun.apidoc.core.common.helper.FileHelper;
import com.github.fengyuchenglun.apidoc.core.render.MarkdownRender;
import com.github.fengyuchenglun.apidoc.core.render.ProjectRender;
import lombok.Getter;
import lombok.Setter;
......@@ -13,8 +14,6 @@ import java.nio.file.Paths;
import java.util.List;
import java.util.Map;
import static com.kim.apidoc.core.common.Constants.MARKDOWN_TEMPLATE;
/**
* The type Context.
*
......@@ -109,7 +108,7 @@ public class Context {
* markdown模版文件路径
*/
@Setter
private String markdownTemplate = MARKDOWN_TEMPLATE;
private String markdownTemplate = Constants.MARKDOWN_TEMPLATE;
/**
* 自定义扩展参数
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/Assert.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/Assert.java
View file @ ca53f41f
package com.kim.apidoc.core.common;
package com.github.fengyuchenglun.apidoc.core.common;
import com.google.common.base.Strings;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/Constants.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/Constants.java
View file @ ca53f41f
package com.kim.apidoc.core.common;
package com.github.fengyuchenglun.apidoc.core.common;
import java.nio.charset.StandardCharsets;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/ObjectMappers.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/ObjectMappers.java
View file @ ca53f41f
package com.kim.apidoc.core.common;
package com.github.fengyuchenglun.apidoc.core.common;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.core.JsonProcessingException;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/QueryStringBuilder.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/QueryStringBuilder.java
View file @ ca53f41f
package com.kim.apidoc.core.common;
package com.github.fengyuchenglun.apidoc.core.common;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/URI.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/URI.java
View file @ ca53f41f
package com.kim.apidoc.core.common;
package com.github.fengyuchenglun.apidoc.core.common;
import com.kim.apidoc.core.common.helper.StringHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.StringHelper;
import com.google.common.collect.Lists;
import lombok.EqualsAndHashCode;
import lombok.Getter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/description/ArrayTypeDescription.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/description/ArrayTypeDescription.java
View file @ ca53f41f
package com.kim.apidoc.core.common.description;
package com.github.fengyuchenglun.apidoc.core.common.description;
import com.kim.apidoc.core.schema.Row;
import com.kim.apidoc.core.common.ObjectMappers;
import com.github.fengyuchenglun.apidoc.core.common.ObjectMappers;
import com.github.fengyuchenglun.apidoc.core.schema.Row;
import com.fasterxml.jackson.databind.node.ArrayNode;
import java.util.ArrayList;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/description/ObjectTypeDescription.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/description/ObjectTypeDescription.java
View file @ ca53f41f
package com.kim.apidoc.core.common.description;
package com.github.fengyuchenglun.apidoc.core.common.description;
import com.kim.apidoc.core.schema.Row;
import com.kim.apidoc.core.common.ObjectMappers;
import com.github.fengyuchenglun.apidoc.core.common.ObjectMappers;
import com.github.fengyuchenglun.apidoc.core.schema.Row;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.collect.Lists;
import lombok.Getter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/description/PrimitiveTypeDescription.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/description/PrimitiveTypeDescription.java
View file @ ca53f41f
package com.kim.apidoc.core.common.description;
package com.github.fengyuchenglun.apidoc.core.common.description;
import com.github.javaparser.resolution.types.ResolvedPrimitiveType;
import com.github.javaparser.resolution.types.ResolvedReferenceType;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/description/TypeDescription.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/description/TypeDescription.java
View file @ ca53f41f
package com.kim.apidoc.core.common.description;
package com.github.fengyuchenglun.apidoc.core.common.description;
import com.github.fengyuchenglun.apidoc.core.common.helper.CommentHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.StringHelper;
import com.github.fengyuchenglun.apidoc.core.schema.Row;
import com.github.javaparser.ast.comments.Comment;
import com.github.javaparser.javadoc.Javadoc;
import com.google.common.collect.Lists;
import com.kim.apidoc.core.common.helper.CommentHelper;
import com.kim.apidoc.core.common.helper.StringHelper;
import com.kim.apidoc.core.schema.Row;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/description/UnAvailableTypeDescription.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/description/UnAvailableTypeDescription.java
View file @ ca53f41f
package com.kim.apidoc.core.common.description;
package com.github.fengyuchenglun.apidoc.core.common.description;
import com.kim.apidoc.core.schema.Row;
import com.github.fengyuchenglun.apidoc.core.schema.Row;
import java.util.Collection;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/diff/FileMatcher.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/diff/FileMatcher.java
View file @ ca53f41f
package com.kim.apidoc.core.common.diff;
package com.github.fengyuchenglun.apidoc.core.common.diff;
import com.google.common.base.Charsets;
import lombok.Getter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/diff/FileSystem.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/diff/FileSystem.java
View file @ ca53f41f
package com.kim.apidoc.core.common.diff;
package com.github.fengyuchenglun.apidoc.core.common.diff;
import java.awt.*;
import java.io.File;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/diff/MatchPatcher.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/diff/MatchPatcher.java
View file @ ca53f41f
......@@ -15,7 +15,7 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.kim.apidoc.core.common.diff;
package com.github.fengyuchenglun.apidoc.core.common.diff;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/AnnotationHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/AnnotationHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.ast.expr.*;
import com.github.javaparser.ast.nodeTypes.NodeWithAnnotations;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/ClassDeclarationHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/ClassDeclarationHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import com.github.javaparser.ast.type.ClassOrInterfaceType;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/CommentHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/CommentHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.ast.body.FieldDeclaration;
import com.github.javaparser.ast.body.MethodDeclaration;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/CompilationUnitHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/CompilationUnitHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.Node;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/EnumHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/EnumHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.fengyuchenglun.apidoc.core.schema.Cell;
import com.github.javaparser.ast.body.EnumConstantDeclaration;
import com.github.javaparser.ast.body.EnumDeclaration;
import com.github.javaparser.ast.expr.Expression;
import com.github.javaparser.resolution.declarations.ResolvedEnumConstantDeclaration;
import com.github.javaparser.resolution.declarations.ResolvedEnumDeclaration;
import com.kim.apidoc.core.schema.Cell;
import java.util.ArrayList;
import java.util.List;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/ExpressionHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/ExpressionHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.ast.NodeList;
import com.github.javaparser.ast.expr.*;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/FieldHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/FieldHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.fengyuchenglun.apidoc.core.schema.Cell;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import com.github.javaparser.ast.body.FieldDeclaration;
import com.github.javaparser.ast.body.VariableDeclarator;
import com.github.javaparser.ast.comments.Comment;
import com.github.javaparser.ast.expr.Expression;
import com.github.javaparser.resolution.declarations.ResolvedFieldDeclaration;
import com.github.javaparser.symbolsolver.javaparsermodel.declarations.JavaParserFieldDeclaration;
import com.kim.apidoc.core.schema.Cell;
import java.util.ArrayList;
import java.util.List;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/FileHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/FileHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.google.common.collect.Lists;
import lombok.extern.slf4j.Slf4j;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/JsonPropertyHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/JsonPropertyHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.ast.body.FieldDeclaration;
import com.github.javaparser.ast.expr.AnnotationExpr;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/OptionalHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/OptionalHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import java.util.Optional;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/ReferenceContext.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/ReferenceContext.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.google.common.collect.Sets;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/StringHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/StringHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.google.common.base.Strings;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/TypeNameHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/TypeNameHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.ImportDeclaration;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/TypeParameterHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/TypeParameterHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.resolution.declarations.ResolvedTypeParameterDeclaration;
import com.github.javaparser.resolution.types.ResolvedReferenceType;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/helper/ValidationHelper.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/helper/ValidationHelper.java
View file @ ca53f41f
package com.kim.apidoc.core.common.helper;
package com.github.fengyuchenglun.apidoc.core.common.helper;
import com.github.javaparser.ast.body.FieldDeclaration;
import com.github.javaparser.ast.expr.AnnotationExpr;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/markup/MarkupBuilder.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/markup/MarkupBuilder.java
View file @ ca53f41f
package com.kim.apidoc.core.common.markup;
package com.github.fengyuchenglun.apidoc.core.common.markup;
import com.kim.apidoc.core.common.markup.asciidoc.AsciiDocBuilder;
import com.github.fengyuchenglun.apidoc.core.common.markup.asciidoc.AsciiDocBuilder;
import java.util.List;
import java.util.function.Consumer;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/markup/asciidoc/AsciiDoc.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/markup/asciidoc/AsciiDoc.java
View file @ ca53f41f
package com.kim.apidoc.core.common.markup.asciidoc;
package com.github.fengyuchenglun.apidoc.core.common.markup.asciidoc;
public enum AsciiDoc implements CharSequence {
EXTENSION(".adoc"),
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/markup/asciidoc/AsciiDocBuilder.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/markup/asciidoc/AsciiDocBuilder.java
View file @ ca53f41f
package com.kim.apidoc.core.common.markup.asciidoc;
package com.github.fengyuchenglun.apidoc.core.common.markup.asciidoc;
import com.kim.apidoc.core.common.markup.MarkupBuilder;
import com.kim.apidoc.core.common.Assert;
import com.github.fengyuchenglun.apidoc.core.common.Assert;
import com.github.fengyuchenglun.apidoc.core.common.markup.MarkupBuilder;
import com.google.common.base.Strings;
import java.util.List;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/markup/asciidoc/Color.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/markup/asciidoc/Color.java
View file @ ca53f41f
package com.kim.apidoc.core.common.markup.asciidoc;
package com.github.fengyuchenglun.apidoc.core.common.markup.asciidoc;
/**
* https://en.wikipedia.org/wiki/Web_colors#HTML_color_names
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/markup/markdown/Markdown.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/markup/markdown/Markdown.java
View file @ ca53f41f
package com.kim.apidoc.core.common.markup.markdown;
package com.github.fengyuchenglun.apidoc.core.common.markup.markdown;
public enum Markdown implements CharSequence {
EXTENSION(".md"),
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/markup/markdown/MarkdownBuilder.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/markup/markdown/MarkdownBuilder.java
View file @ ca53f41f
package com.kim.apidoc.core.common.markup.markdown;
package com.github.fengyuchenglun.apidoc.core.common.markup.markdown;
import com.kim.apidoc.core.common.markup.MarkupBuilder;
import com.kim.apidoc.core.common.Assert;
import com.github.fengyuchenglun.apidoc.core.common.Assert;
import com.github.fengyuchenglun.apidoc.core.common.markup.MarkupBuilder;
import com.google.common.base.Strings;
import java.util.List;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Body.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Body.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/BodyMode.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/BodyMode.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
/**
* 对应postman定义的mode
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Folder.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Folder.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Getter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Info.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Info.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Item.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Item.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Parameter.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Parameter.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import com.kim.apidoc.core.schema.Row;
import com.github.fengyuchenglun.apidoc.core.schema.Row;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Postman.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Postman.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Request.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Request.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import com.kim.apidoc.core.schema.Header;
import com.kim.apidoc.core.schema.Method;
import com.github.fengyuchenglun.apidoc.core.schema.Header;
import com.github.fengyuchenglun.apidoc.core.schema.Method;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Response.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Response.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import com.kim.apidoc.core.schema.Header;
import com.github.fengyuchenglun.apidoc.core.schema.Header;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/common/postman/Url.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/common/postman/Url.java
View file @ ca53f41f
package com.kim.apidoc.core.common.postman;
package com.github.fengyuchenglun.apidoc.core.common.postman;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/parser/ParserStrategy.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/parser/ParserStrategy.java
View file @ ca53f41f
package com.kim.apidoc.core.parser;
package com.github.fengyuchenglun.apidoc.core.parser;
import com.kim.apidoc.core.schema.Chapter;
import com.kim.apidoc.core.schema.Section;
import com.github.fengyuchenglun.apidoc.core.schema.Chapter;
import com.github.fengyuchenglun.apidoc.core.schema.Section;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import com.github.javaparser.ast.body.MethodDeclaration;
......
apidoc-core/src/main/java/com/kim/apidoc/core/parser/VisitorParser.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/parser/VisitorParser.java
View file @ ca53f41f
package com.kim.apidoc.core.parser;
package com.github.fengyuchenglun.apidoc.core.parser;
import com.github.fengyuchenglun.apidoc.core.schema.*;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import com.github.javaparser.ast.body.EnumDeclaration;
import com.github.javaparser.ast.body.MethodDeclaration;
import com.github.javaparser.ast.comments.JavadocComment;
import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.helper.OptionalHelper;
import com.kim.apidoc.core.schema.*;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.helper.OptionalHelper;
/**
......
apidoc-core/src/main/java/com/kim/apidoc/core/render/AsciiDocRender.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/render/AsciiDocRender.java
View file @ ca53f41f
package com.kim.apidoc.core.render;
package com.github.fengyuchenglun.apidoc.core.render;
import com.github.fengyuchenglun.apidoc.core.schema.*;
import com.google.common.collect.Lists;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.helper.FileHelper;
import com.kim.apidoc.core.common.helper.StringHelper;
import com.kim.apidoc.core.common.markup.MarkupBuilder;
import com.kim.apidoc.core.common.markup.asciidoc.AsciiDoc;
import com.kim.apidoc.core.schema.*;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.helper.FileHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.StringHelper;
import com.github.fengyuchenglun.apidoc.core.common.markup.MarkupBuilder;
import com.github.fengyuchenglun.apidoc.core.common.markup.asciidoc.AsciiDoc;
import lombok.extern.slf4j.Slf4j;
import org.asciidoctor.Asciidoctor;
import org.asciidoctor.AttributesBuilder;
......
apidoc-core/src/main/java/com/kim/apidoc/core/render/MarkdownRender.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/render/MarkdownRender.java
View file @ ca53f41f
package com.kim.apidoc.core.render;
package com.github.fengyuchenglun.apidoc.core.render;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.Constants;
import com.kim.apidoc.core.common.ObjectMappers;
import com.kim.apidoc.core.common.helper.FileHelper;
import com.kim.apidoc.core.schema.Project;
import com.github.fengyuchenglun.apidoc.core.common.Constants;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.helper.FileHelper;
import com.github.fengyuchenglun.apidoc.core.schema.Project;
import freemarker.template.Configuration;
import freemarker.template.Template;
import lombok.extern.slf4j.Slf4j;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.io.StringWriter;
import java.nio.file.Path;
......
apidoc-core/src/main/java/com/kim/apidoc/core/render/PostmanRender.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/render/PostmanRender.java
View file @ ca53f41f
package com.kim.apidoc.core.render;
package com.github.fengyuchenglun.apidoc.core.render;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.ObjectMappers;
import com.kim.apidoc.core.common.helper.FileHelper;
import com.kim.apidoc.core.common.postman.*;
import com.kim.apidoc.core.schema.*;
import com.github.fengyuchenglun.apidoc.core.common.ObjectMappers;
import com.github.fengyuchenglun.apidoc.core.common.postman.*;
import com.github.fengyuchenglun.apidoc.core.schema.*;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.helper.FileHelper;
import lombok.extern.slf4j.Slf4j;
import java.nio.file.Path;
......
apidoc-core/src/main/java/com/kim/apidoc/core/render/ProjectRender.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/render/ProjectRender.java
View file @ ca53f41f
package com.kim.apidoc.core.render;
package com.github.fengyuchenglun.apidoc.core.render;
import com.kim.apidoc.core.schema.Project;
import com.github.fengyuchenglun.apidoc.core.schema.Project;
/**
* The interface Project render.
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/ArrayTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/ArrayTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.description.ArrayTypeDescription;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.ArrayTypeDescription;
import com.github.javaparser.resolution.types.ResolvedType;
public class ArrayTypeResolver implements TypeResolver {
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/CollectionTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/CollectionTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.helper.TypeParameterHelper;
import com.kim.apidoc.core.common.description.ArrayTypeDescription;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.helper.TypeParameterHelper;
import com.github.fengyuchenglun.apidoc.core.common.description.ArrayTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.javaparser.resolution.types.ResolvedType;
import com.google.common.collect.ImmutableList;
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/DateTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/DateTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.description.StringTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.StringTypeDescription;
import com.github.javaparser.resolution.types.ResolvedType;
import com.google.common.collect.ImmutableList;
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/EnumTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/EnumTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.StringTypeDescription;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.StringTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.javaparser.resolution.declarations.ResolvedEnumConstantDeclaration;
import com.github.javaparser.resolution.declarations.ResolvedEnumDeclaration;
import com.github.javaparser.resolution.types.ResolvedType;
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/MapTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/MapTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.javaparser.resolution.types.ResolvedType;
import com.google.common.collect.ImmutableList;
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/ObjectTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/ObjectTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.github.fengyuchenglun.apidoc.core.common.helper.*;
import com.github.javaparser.resolution.declarations.ResolvedFieldDeclaration;
import com.github.javaparser.resolution.types.ResolvedReferenceType;
import com.github.javaparser.resolution.types.ResolvedType;
import com.github.javaparser.symbolsolver.javaparsermodel.declarations.JavaParserClassDeclaration;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.description.ObjectTypeDescription;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.helper.*;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.description.ObjectTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import java.util.Optional;
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/PrimitiveTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/PrimitiveTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.PrimitiveTypeDescription;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.PrimitiveTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.javaparser.resolution.types.ResolvedType;
import com.google.common.collect.ImmutableList;
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/StringTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/StringTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.description.StringTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.StringTypeDescription;
import com.github.javaparser.resolution.types.ResolvedType;
import com.google.common.collect.ImmutableList;
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/SystemObjectTypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/SystemObjectTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.javaparser.resolution.types.ResolvedType;
public class SystemObjectTypeResolver implements TypeResolver {
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/TypeNameResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/TypeNameResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.javaparser.ast.type.Type;
public interface TypeNameResolver {
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/TypeResolver.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/TypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.javaparser.resolution.types.ResolvedType;
public interface TypeResolver {
......
apidoc-core/src/main/java/com/kim/apidoc/core/resolver/TypeResolvers.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/resolver/TypeResolvers.java
View file @ ca53f41f
package com.kim.apidoc.core.resolver;
package com.github.fengyuchenglun.apidoc.core.resolver;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.helper.TypeNameHelper;
import com.kim.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.helper.TypeNameHelper;
import com.github.fengyuchenglun.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.javaparser.ast.type.Type;
import com.github.javaparser.resolution.UnsolvedSymbolException;
import com.github.javaparser.resolution.types.ResolvedType;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Appendix.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Appendix.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import com.github.javaparser.ast.body.BodyDeclaration;
import com.github.javaparser.ast.comments.JavadocComment;
import com.github.javaparser.ast.nodeTypes.NodeWithSimpleName;
import com.kim.apidoc.core.common.helper.EnumHelper;
import com.kim.apidoc.core.common.helper.FieldHelper;
import com.kim.apidoc.core.common.helper.FileHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.EnumHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.FieldHelper;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Book.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Book.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Cell.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Cell.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import com.google.common.collect.Lists;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Chapter.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Chapter.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Header.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Header.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import lombok.Getter;
import lombok.NoArgsConstructor;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Method.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Method.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import lombok.extern.slf4j.Slf4j;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Node.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Node.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import com.github.fengyuchenglun.apidoc.core.Context;
import com.github.javaparser.ast.comments.Comment;
import com.github.javaparser.javadoc.Javadoc;
import com.kim.apidoc.core.Context;
import com.kim.apidoc.core.common.helper.CommentHelper;
import com.kim.apidoc.core.common.helper.StringHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.CommentHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.StringHelper;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Project.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Project.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import lombok.Getter;
......
apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/RequestParameterType.java 0 → 100644
View file @ ca53f41f
package com.github.fengyuchenglun.apidoc.core.schema;
/**
* 请求参数枚举类型
*
* @author duanledexianxianxian
* @date 2020 /3/29 0:37
* @since 1.0.0
*/
public enum RequestParameterType {
/**
* 查询参数.
*/
QUERY("QUERY", "查询参数"),
/**
* 路径参数.
*/
PATH("PATH", "路径参数"),
/**
* 请求参数体.
*/
BODY("BODY", "请求体");
/**
* 编码
*/
private String code;
/**
* 信息
*/
private String msg;
RequestParameterType(String code, String msg) {
this.code = code;
this.msg = msg;
}
public String getCode() {
return code;
}
public void setCode(String code) {
this.code = code;
}
public String getMsg() {
return msg;
}
public void setMsg(String msg) {
this.msg = msg;
}
}
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Row.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Row.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import lombok.*;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Section.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Section.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import com.kim.apidoc.core.common.ObjectMappers;
import com.kim.apidoc.core.common.QueryStringBuilder;
import com.kim.apidoc.core.common.helper.StringHelper;
import com.github.fengyuchenglun.apidoc.core.common.ObjectMappers;
import com.github.fengyuchenglun.apidoc.core.common.QueryStringBuilder;
import com.github.fengyuchenglun.apidoc.core.common.helper.StringHelper;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import lombok.Getter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/Tag.java → apidoc-core/src/main/java/com/github/fengyuchenglun/apidoc/core/schema/Tag.java
View file @ ca53f41f
package com.kim.apidoc.core.schema;
package com.github.fengyuchenglun.apidoc.core.schema;
import lombok.Getter;
import lombok.Setter;
......
apidoc-core/src/main/java/com/kim/apidoc/core/schema/RequestParameterType.java deleted 100644 → 0
View file @ d1cdf8f4
package com.kim.apidoc.core.schema;
/**
* 请求参数枚举类型
*
* @author duanledexianxianxian
* @date 2020 /3/29 0:37
* @since 1.0.0
*/
public enum RequestParameterType {
/**
* 查询参数.
*/
QUERY,
/**
* 路径参数.
*/
PATH,
/**
* 请求参数体.
*/
BODY
}
apidoc-core/src/main/resources/templates/markdown.ftl
View file @ ca53f41f
[TOC]
<#-- ---------- BEGIN 循环遍历book ---------->
<#if books??>
<#list books as bookKey,bookValue>
......
apidoc-springmvc/src/main/java/com/kim/apidoc/springmvc/ParameterHelper.java → apidoc-springmvc/src/main/java/com/github/fengyuchenglun/apidoc/springmvc/ParameterHelper.java
View file @ ca53f41f
package com.kim.apidoc.springmvc;
package com.github.fengyuchenglun.apidoc.springmvc;
import com.github.javaparser.ast.NodeList;
import com.github.javaparser.ast.body.Parameter;
......
apidoc-springmvc/src/main/java/com/kim/apidoc/springmvc/RequestMappingHelper.java → apidoc-springmvc/src/main/java/com/github/fengyuchenglun/apidoc/springmvc/RequestMappingHelper.java
View file @ ca53f41f
package com.kim.apidoc.springmvc;
package com.github.fengyuchenglun.apidoc.springmvc;
import com.kim.apidoc.core.common.URI;
import com.kim.apidoc.core.common.helper.AnnotationHelper;
import com.kim.apidoc.core.common.helper.ClassDeclarationHelper;
import com.kim.apidoc.core.common.helper.ExpressionHelper;
import com.kim.apidoc.core.schema.Method;
import com.github.fengyuchenglun.apidoc.core.common.URI;
import com.github.fengyuchenglun.apidoc.core.common.helper.AnnotationHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.ClassDeclarationHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.ExpressionHelper;
import com.github.fengyuchenglun.apidoc.core.schema.Method;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.NodeList;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
......
apidoc-springmvc/src/main/java/com/kim/apidoc/springmvc/SpringMVCContext.java → apidoc-springmvc/src/main/java/com/github/fengyuchenglun/apidoc/springmvc/SpringMVCContext.java
View file @ ca53f41f
package com.kim.apidoc.springmvc;
package com.github.fengyuchenglun.apidoc.springmvc;
import com.kim.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.google.common.collect.Lists;
import lombok.Data;
......
apidoc-springmvc/src/main/java/com/kim/apidoc/springmvc/SpringParser.java → apidoc-springmvc/src/main/java/com/github/fengyuchenglun/apidoc/springmvc/SpringParser.java
View file @ ca53f41f
package com.kim.apidoc.springmvc;
package com.github.fengyuchenglun.apidoc.springmvc;
import com.github.fengyuchenglun.apidoc.core.common.helper.AnnotationHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.ClassDeclarationHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.ExpressionHelper;
import com.github.fengyuchenglun.apidoc.core.common.helper.StringHelper;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import com.github.javaparser.ast.body.MethodDeclaration;
import com.github.javaparser.ast.body.Parameter;
import com.github.javaparser.ast.expr.AnnotationExpr;
import com.github.javaparser.ast.expr.Expression;
import com.github.javaparser.ast.type.ClassOrInterfaceType;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.URI;
import com.kim.apidoc.core.common.description.ObjectTypeDescription;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.helper.*;
import com.kim.apidoc.core.parser.ParserStrategy;
import com.kim.apidoc.core.schema.Chapter;
import com.kim.apidoc.core.schema.Header;
import com.kim.apidoc.core.schema.Row;
import com.kim.apidoc.core.schema.Section;
import com.kim.apidoc.springmvc.resovler.SpringComponentTypeResolver;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.URI;
import com.github.fengyuchenglun.apidoc.core.common.description.ObjectTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.parser.ParserStrategy;
import com.github.fengyuchenglun.apidoc.core.schema.Chapter;
import com.github.fengyuchenglun.apidoc.core.schema.Header;
import com.github.fengyuchenglun.apidoc.core.schema.Row;
import com.github.fengyuchenglun.apidoc.core.schema.Section;
import com.github.fengyuchenglun.apidoc.springmvc.resovler.SpringComponentTypeResolver;
import java.util.List;
import java.util.Optional;
import static com.kim.apidoc.core.schema.RequestParameterType.*;
import static com.github.fengyuchenglun.apidoc.core.schema.RequestParameterType.*;
/**
......@@ -157,7 +160,7 @@ public class SpringParser implements ParserStrategy {
if (ParameterHelper.isPathVariable(parameter)) {
section.getPathVariable().put(parameter.getNameAsString(), "");
Row row = new Row();
row.setRequestParameterType(PATH.name());
row.setRequestParameterType(PATH.getMsg());
row.setKey(parameter.getNameAsString());
row.setType(parameter.getType().toString());
// 路径参数必填
......@@ -236,7 +239,7 @@ public class SpringParser implements ParserStrategy {
} else if (description.isObject()) {
section.setParameter(description.asObject().getValue());
}
section.addRequestRows(description.rows(BODY.name()));
section.addRequestRows(description.rows(BODY.getMsg()));
}
break;
}
......@@ -295,11 +298,11 @@ public class SpringParser implements ParserStrategy {
}
}
section.setParameter(objectTypeDescription.getValue());
section.addRequestRows(objectTypeDescription.rows(QUERY.name()));
section.addRequestRows(objectTypeDescription.rows(QUERY.getMsg()));
}
/**
* 解析方法返回参 数
* 解析方法返回参数
*
* @param n the n
* @param chapter the chapter
......
apidoc-springmvc/src/main/java/com/kim/apidoc/springmvc/resovler/SpringComponentTypeResolver.java → apidoc-springmvc/src/main/java/com/github/fengyuchenglun/apidoc/springmvc/resovler/SpringComponentTypeResolver.java
View file @ ca53f41f
package com.kim.apidoc.springmvc.resovler;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.common.description.TypeDescription;
import com.kim.apidoc.core.common.description.UnAvailableTypeDescription;
import com.kim.apidoc.core.common.helper.TypeParameterHelper;
import com.kim.apidoc.core.resolver.TypeNameResolver;
import com.kim.apidoc.core.resolver.TypeResolver;
package com.github.fengyuchenglun.apidoc.springmvc.resovler;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.common.description.TypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.description.UnAvailableTypeDescription;
import com.github.fengyuchenglun.apidoc.core.common.helper.TypeParameterHelper;
import com.github.fengyuchenglun.apidoc.core.resolver.TypeNameResolver;
import com.github.fengyuchenglun.apidoc.core.resolver.TypeResolver;
import com.github.javaparser.ast.NodeList;
import com.github.javaparser.ast.type.Type;
import com.github.javaparser.resolution.types.ResolvedType;
......
apidoc-springmvc/src/main/resources/META-INF/services/com.github.fengyuchenglun.apidoc.core.parser.ParserStrategy 0 → 100644
View file @ ca53f41f
com.github.fengyuchenglun.apidoc.springmvc.SpringParser
\ No newline at end of file
apidoc-springmvc/src/test/java/com/kim/apidoc/springmvc/SpringTest.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/apidoc/springmvc/SpringTest.java
View file @ ca53f41f
package com.kim.apidoc.springmvc;
package com.github.fengyuchenglun.apidoc.springmvc;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.Context;
import com.kim.apidoc.core.common.diff.FileMatcher;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.Context;
import com.github.fengyuchenglun.apidoc.core.common.diff.FileMatcher;
import org.junit.Test;
import java.io.IOException;
......@@ -17,7 +17,7 @@ public class SpringTest {
Context context = new Context();
context.setId("test");
context.setName("测试项目");
context.addSource(Paths.get("K:\\@project-dianli@\\tool\\apidoc\\apidoc-springmvc\\src\\test\\java"));
context.addSource(Paths.get("F:\\@project@\\@dianli@\\tool\\apidoc\\apidoc-springmvc\\src\\test\\java"));
// context.setCss("https://darshandsoni.com/asciidoctor-skins/css/monospace.css");
ApiDoc apigcc = new ApiDoc(context);
......
apidoc-springmvc/src/test/java/com/kim/apidoc/example/ApigccTest.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/ApigccTest.java
View file @ ca53f41f
package com.kim.apidoc.example;
import com.kim.apidoc.core.ApiDoc;
import com.kim.apidoc.core.Context;
import org.junit.Test;
import java.nio.file.Paths;
/**
* @title Apigcc示例文档
* @description 通过javadoc设置文档描述信息
* 优先级大于通过Environment.description()设置的值
* @readme 所有接口均使用Https调用
* /app路径下的接口为app专用
* /mini路径下的接口为小程序专用
*/
public class ApigccTest {
@Test
public void testApigcc() {
Context context = new Context();
context.setId("test");
context.setName("测试项目");
context.addSource(Paths.get("D:/apigcc/apigcc-demo-spring"));
//context.setCss("https://darshandsoni.com/asciidoctor-skins/css/monospace.css");
ApiDoc apigcc = new ApiDoc(context);
apigcc.parse();
apigcc.render();
}
package com.github.fengyuchenglun.example;
import com.github.fengyuchenglun.apidoc.core.ApiDoc;
import com.github.fengyuchenglun.apidoc.core.Context;
import org.junit.Test;
import java.nio.file.Paths;
/**
* @title Apigcc示例文档
* @description 通过javadoc设置文档描述信息
* 优先级大于通过Environment.description()设置的值
* @readme 所有接口均使用Https调用
* /app路径下的接口为app专用
* /mini路径下的接口为小程序专用
*/
public class ApigccTest {
@Test
public void testApigcc() {
Context context = new Context();
context.setId("test");
context.setName("测试项目");
context.addSource(Paths.get("D:/apigcc/apigcc-demo-spring"));
//context.setCss("https://darshandsoni.com/asciidoctor-skins/css/monospace.css");
ApiDoc apigcc = new ApiDoc(context);
apigcc.parse();
apigcc.render();
}
}
\ No newline at end of file
apidoc-springmvc/src/test/java/com/kim/apidoc/example/annotation/KimController.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/annotation/KimController.java
View file @ ca53f41f
package com.kim.apidoc.example.annotation;
package com.github.fengyuchenglun.example.annotation;
import org.springframework.stereotype.Controller;
import java.lang.annotation.ElementType;
......
apidoc-springmvc/src/test/java/com/kim/apidoc/example/annotation/KimResponseBody.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/annotation/KimResponseBody.java
View file @ ca53f41f
package com.kim.apidoc.example.annotation;
package com.github.fengyuchenglun.example.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
......
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/Code.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/Code.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
/**
* @code
*/
public enum Code{
OK(0,"ok"),
ERROR(-1,"error"),
NoAuth(1,"no auth");
private int code;
private String text;
Code(int code, String text) {
this.code = code;
this.text = text;
}
package com.github.fengyuchenglun.example.common;
/**
* @code
*/
public enum Code{
OK(0,"ok"),
ERROR(-1,"error"),
NoAuth(1,"no auth");
private int code;
private String text;
Code(int code, String text) {
this.code = code;
this.text = text;
}
}
\ No newline at end of file
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/Menu.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/Menu.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
import lombok.Getter;
import lombok.Setter;
import java.util.List;
@Getter
@Setter
public class Menu {
int id;
String name;
List<Menu> menus;
}
package com.github.fengyuchenglun.example.common;
import lombok.Getter;
import lombok.Setter;
import java.util.List;
@Getter
@Setter
public class Menu {
int id;
String name;
List<Menu> menus;
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/Page.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/Page.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
import com.alibaba.fastjson.annotation.JSONField;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.gson.annotations.SerializedName;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class Page extends Query {
/**
* 第几页
*/
@JsonProperty
int page = 1;
/* 每页条数 */
@JSONField(name = "limit")
int sizs = 20;
@SerializedName("totalPage")
int total = 0;
@JsonProperty("max")
int maxPage = 0;
}
package com.github.fengyuchenglun.example.common;
import com.alibaba.fastjson.annotation.JSONField;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.gson.annotations.SerializedName;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class Page extends Query {
/**
* 第几页
*/
@JsonProperty
int page = 1;
/* 每页条数 */
@JSONField(name = "limit")
int sizs = 20;
@SerializedName("totalPage")
int total = 0;
@JsonProperty("max")
int maxPage = 0;
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/Query.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/Query.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class Query {
/**
* static will be ignore
*/
public static final String CONSTANS = "";
/**
* 查询关键字
*/
String q = "123";
}
package com.github.fengyuchenglun.example.common;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class Query {
/**
* static will be ignore
*/
public static final String CONSTANS = "";
/**
* 查询关键字
*/
String q = "123";
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/ResultData.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/ResultData.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
import lombok.Getter;
import lombok.Setter;
/**
* The type Result data.
*
* @param <T> the type parameter
* @author fengyuchenglun
* @version 1.0.0
* @resultData
*/
@Setter
@Getter
public class ResultData<T> {
/**
* 返回码
*/
int code;
/**
* The Msg.
*/
//返回信息
String msg;
/**
* The Data.
*/
T data;
/**
* Ok result data.
*
* @param <T> the type parameter
* @return the result data
*/
public static <T> ResultData<T> ok(){
return ok(null);
}
/**
* Ok result data.
*
* @param <T> the type parameter
* @param data the data
* @return the result data
*/
public static <T> ResultData<T> ok(T data){
ResultData<T> resultData = new ResultData<>();
resultData.code = 0;
resultData.msg = "ok";
resultData.data = data;
return resultData;
}
}
package com.github.fengyuchenglun.example.common;
import lombok.Getter;
import lombok.Setter;
/**
* The type Result data.
*
* @param <T> the type parameter
* @author fengyuchenglun
* @version 1.0.0
* @resultData
*/
@Setter
@Getter
public class ResultData<T> {
/**
* 返回码
*/
int code;
/**
* The Msg.
*/
//返回信息
String msg;
/**
* The Data.
*/
T data;
/**
* Ok result data.
*
* @param <T> the type parameter
* @return the result data
*/
public static <T> ResultData<T> ok(){
return ok(null);
}
/**
* Ok result data.
*
* @param <T> the type parameter
* @param data the data
* @return the result data
*/
public static <T> ResultData<T> ok(T data){
ResultData<T> resultData = new ResultData<>();
resultData.code = 0;
resultData.msg = "ok";
resultData.data = data;
return resultData;
}
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/Role.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/Role.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
/**
* 用户角色
*
* @code
*/
public enum Role {
/**
* Admin role.
*/
ADMIN("管理员"),
/**
* User role.
*/
USER("用户"),
/**
* Vip role.
*/
VIP("会员");
/**
* The Text.
*/
String text;
/**
* Instantiates a new Role.
*
* @param text the text
*/
Role(String text) {
this.text = text;
}
}
package com.github.fengyuchenglun.example.common;
/**
* 用户角色
*
* @code
*/
public enum Role {
/**
* Admin role.
*/
ADMIN("管理员"),
/**
* User role.
*/
USER("用户"),
/**
* Vip role.
*/
VIP("会员");
/**
* The Text.
*/
String text;
/**
* Instantiates a new Role.
*
* @param text the text
*/
Role(String text) {
this.text = text;
}
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/StaticFinalCode.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/StaticFinalCode.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
/**
* @code
*/
public class StaticFinalCode {
/**
* 成功
*/
public static final int SUCCESS = 1;
/**
* 失败
*/
public static final int ERROR = -1;
}
package com.github.fengyuchenglun.example.common;
/**
* @code
*/
public class StaticFinalCode {
/**
* 成功
*/
public static final int SUCCESS = 1;
/**
* 失败
*/
public static final int ERROR = -1;
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/User.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/User.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Getter;
import lombok.Setter;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import java.util.Date;
/**
* 用户对象
*
* @author fengyuchenglun
* @version 1.0.0
*/
@Setter
@Getter
public class User {
/**
* 用户编号.
*/
int id;
/**
* 用户名称.
*/
@NotBlank
String name;
/**
* 用户年龄.
*/
@Min(1)
@NotNull
Integer age;
/**
* 创建时间.
*/
Date createAt;
/**
* 性别.
*/
@NotBlank
@JsonProperty("Sex")
String sex;
}
package com.github.fengyuchenglun.example.common;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Getter;
import lombok.Setter;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import java.util.Date;
/**
* 用户对象
*
* @author fengyuchenglun
* @version 1.0.0
*/
@Setter
@Getter
public class User {
/**
* 用户编号.
*/
int id;
/**
* 用户名称.
*/
@NotBlank
String name;
/**
* 用户年龄.
*/
@Min(1)
@NotNull
Integer age;
/**
* 创建时间.
*/
Date createAt;
/**
* 性别.
*/
@NotBlank
@JsonProperty("Sex")
String sex;
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/UserDTO.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/UserDTO.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
import lombok.Getter;
import lombok.Setter;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.util.Date;
import java.util.List;
import java.util.Map;
@Setter
@Getter
public class UserDTO {
/**
* 编号
*/
Integer id;
/*姓名*/
@Size(min = 5, max = 20)
@NotEmpty
String name;
//年龄
@Min(1)
int age;
/**
* 生日，还是推荐使用javadoc
*/
@NotNull
Date birthday;
/**
* 用户标签
*/
@Size(min = 1, max = 2)
List<String> tags;
List<?> data;
/**
* 用户图标
*/
String[] icons;
Map<String, String> attrs;
}
package com.github.fengyuchenglun.example.common;
import lombok.Getter;
import lombok.Setter;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;
import java.util.Date;
import java.util.List;
import java.util.Map;
@Setter
@Getter
public class UserDTO {
/**
* 编号
*/
Integer id;
/*姓名*/
@Size(min = 5, max = 20)
@NotEmpty
String name;
//年龄
@Min(1)
int age;
/**
* 生日，还是推荐使用javadoc
*/
@NotNull
Date birthday;
/**
* 用户标签
*/
@Size(min = 1, max = 2)
List<String> tags;
List<?> data;
/**
* 用户图标
*/
String[] icons;
Map<String, String> attrs;
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/UserDetails.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/UserDetails.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
/**
* 某些用户信息框架，如spring security的用户登录信息
* 此处只是模拟，真实的将调用security中的类
*/
public class UserDetails {
}
package com.github.fengyuchenglun.example.common;
/**
* 某些用户信息框架，如spring security的用户登录信息
* 此处只是模拟，真实的将调用security中的类
*/
public class UserDetails {
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/UserQuery.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/UserQuery.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class UserQuery extends Page {
/**
* 名称
* @value apigcc
*/
String name;
}
package com.github.fengyuchenglun.example.common;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class UserQuery extends Page {
/**
* 名称
* @value apigcc
*/
String name;
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/common/Wrapper.java → apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/common/Wrapper.java
View file @ ca53f41f
package com.kim.apidoc.example.common;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class Wrapper<T> {
String wrapper;
T data;
}
package com.github.fengyuchenglun.example.common;
import lombok.Getter;
import lombok.Setter;
@Setter
@Getter
public class Wrapper<T> {
String wrapper;
T data;
}
apidoc-springmvc/src/test/java/com/github/fengyuchenglun/example/spring/advanced/UserController.java 0 → 100644
View file @ ca53f41f
package com.github.fengyuchenglun.example.spring.advanced;
import com.github.fengyuchenglun.example.annotation.KimController;
import com.github.fengyuchenglun.example.common.Query;
import com.github.fengyuchenglun.example.common.User;
import lombok.Data;
import org.springframework.web.bind.annotation.*;
import java.io.Serializable;
/**
* 用户接口.
*
* @author duanledexianxianxian
* @version 1.0.0
* @date 2020 /3/25 1:00
* @index 20
* @since 1.0.0
*/
@KimController
@RequestMapping("/api/v1/users")
public class UserController {
/**
* 查看用户详情
*
* @param userId 用户编号
* @param query 过滤条件
* @return 用户对象 user
*/
@GetMapping(value = "/{userId}")
public User detail(@PathVariable String userId, Query query) {
User user = new User();
return user;
}
/**
* 查看用户详情
*
* @param query 过滤条件
* @return 用户对象 user
*/
@GetMapping(value = "/detail1")
public User detail1( Query query) {
User user = new User();
return user;
}
/**
* 查看用户详情
*
* @param query 过滤条件
* @return 用户对象 user
*/
@GetMapping(value = "/detail3")
public User detail3(@RequestParam Query query) {
User user = new User();
return user;
}
/**
* 用户表单对象.
*
* @author duanledexianxianxian
*/
@Data
public static class UserForm implements Serializable {
private static final long serialVersionUID = 5681371348688016281L;
/**
* 用户名
*/
private String userName;
/**
* 地址
*/
private String address;
/**
* 年龄
*/
private Integer age;
}
/**
* 添加用户
*
* @param form 用户表单对象
* @return integer integer
*/
@PostMapping
public Integer add(@RequestBody UserForm form) {
return null;
}
}
apidoc-springmvc/src/test/java/com/kim/apidoc/example/spring/advanced/UserController.java deleted 100644 → 0
View file @ d1cdf8f4
package com.kim.apidoc.example.spring.advanced;
import com.kim.apidoc.example.annotation.KimController;
import com.kim.apidoc.example.common.Query;
import com.kim.apidoc.example.common.User;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* The type Kim user controller.
*
* @author duanledexianxianxian
* @version 1.0.0
* @date 2020 /3/25 1:00
* @index 20
* @since 1.0.0
*/
@KimController
@RequestMapping("/api/v1")
public class UserController {
/**
* 查看用户详情
*
* @param userId 用户编号
* @param query 过滤条件
* @return 用户对象 user
*/
@GetMapping(value = "/{userId}")
public User detail(@PathVariable String userId, Query query) {
User user = new User();
return user;
}
/**
* Add integer.
*
* @return integer integer
*/
@PostMapping
public Integer add() {
return null;
}
}
build.gradle
View file @ ca53f41f
......@@ -4,8 +4,8 @@ allprojects {
apply plugin: 'maven'
apply plugin: 'com.novoda.bintray-release'
group 'com.apidoc'
version '1.7.0'
group 'com.github.fengyuchenglun'
version '1.0.0'
sourceCompatibility = 1.8
targetCompatibility = 1.8
......@@ -28,8 +28,8 @@ allprojects {
ext {
DESCRIPTION = 'A rest document generator with parse the source code.'
SITE_URL = 'https://github.com/apigcc/apigcc'
GIT_URL = 'https://github.com/apigcc/apigcc.git'
SITE_URL = 'http://platform.kuopu.net:9999/gitlab/duanledexianxianxian/apidoc'
GIT_URL = 'http://platform.kuopu.net:9999/gitlab/duanledexianxianxian/apidoc.git'
LICENSE = 'MIT License'
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment