类的使用
com.power.doc.model.ApiConfig

使用ApiConfig的程序包

程序包	说明
com.power.doc.builder
com.power.doc.builder.rpc

com.power.doc.builder中ApiConfig的使用

返回ApiConfig的com.power.doc.builder中的方法

限定符和类型	方法和说明
ApiConfig	ProjectDocConfigBuilder.getApiConfig()

参数类型为ApiConfig的com.power.doc.builder中的方法

限定符和类型	方法和说明
void	DocBuilderTemplate.buildAllInOne(List<ApiDoc> apiDocList, ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, String template, String outPutFileName) Merge all api doc into one document
static void	AdocDocBuilder.buildApiDoc(ApiConfig config) build adoc
static void	ApiDocBuilder.buildApiDoc(ApiConfig config)
static void	HtmlApiDocBuilder.buildApiDoc(ApiConfig config) build controller api
static void	AdocDocBuilder.buildApiDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) Only for smart-doc maven plugin and gradle plugin.
static void	ApiDocBuilder.buildApiDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) Only for smart-doc maven plugin and gradle plugin.
static void	HtmlApiDocBuilder.buildApiDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) Only for smart-doc maven plugin and gradle plugin.
void	DocBuilderTemplate.buildApiDoc(List<ApiDoc> apiDocList, ApiConfig config, String template, String fileExtension) Generate api documentation for all controllers.
List<ApiDocDict>	DocBuilderTemplate.buildDictionary(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) Build dictionary
void	DocBuilderTemplate.buildDirectoryDataDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, String template, String outPutFileName) build common_data doc
void	DocBuilderTemplate.buildErrorCodeDoc(ApiConfig config, String template, String outPutFileName) build error_code adoc
static void	OpenApiBuilder.buildOpenApi(ApiConfig config) 构建postman json
static void	OpenApiBuilder.buildOpenApi(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder projectBuilder) Only for smart-doc maven plugin and gradle plugin.
static void	PostmanJsonBuilder.buildPostmanCollection(ApiConfig config) 构建postman json
static void	PostmanJsonBuilder.buildPostmanCollection(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder projectBuilder) Only for smart-doc maven plugin and gradle plugin.
static void	AdocDocBuilder.buildSingleApiDoc(ApiConfig config, String controllerName) Generate a single controller api document
static void	ApiDocBuilder.buildSingleApiDoc(ApiConfig config, String controllerName) Generate a single controller api document
static void	YapiJsonBuilder.buildYapiCollection(ApiConfig config) 构建yapi json
static void	YapiJsonBuilder.buildYapiCollection(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder projectBuilder) Only for smart-doc maven plugin and gradle plugin.
void	BaseDocBuilderTemplate.checkAndInit(ApiConfig config) check condition and init
void	BaseDocBuilderTemplate.checkAndInitForGetApiData(ApiConfig config) check condition and init for get Data
List<ApiErrorCode>	BaseDocBuilderTemplate.errorCodeDictToList(ApiConfig config)
static ApiAllData	ApiDataBuilder.getApiData(ApiConfig config) Get list of ApiDoc
ApiAllData	DocBuilderTemplate.getApiData(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) get all api data
static ApiAllData	ApiDataBuilder.getApiDataTree(ApiConfig config) Get list of ApiDoc
void	BaseDocBuilderTemplate.setDirectoryLanguageVariable(ApiConfig config, org.beetl.core.Template mapper)

参数类型为ApiConfig的com.power.doc.builder中的构造器

构造器和说明
ProjectDocConfigBuilder(ApiConfig apiConfig, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder)

com.power.doc.builder.rpc中ApiConfig的使用

参数类型为ApiConfig的com.power.doc.builder.rpc中的方法

限定符和类型	方法和说明
void	RpcDocBuilderTemplate.buildAllInOne(List<RpcApiDoc> apiDocList, ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder, String template, String outPutFileName) Merge all api doc into one document
static void	RpcAdocBuilder.buildApiDoc(ApiConfig config) build adoc
static void	RpcHtmlBuilder.buildApiDoc(ApiConfig config) build controller api
static void	RpcMarkdownBuilder.buildApiDoc(ApiConfig config)
static void	RpcAdocBuilder.buildApiDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) Only for smart-doc maven plugin and gradle plugin.
static void	RpcHtmlBuilder.buildApiDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) Only for smart-doc maven plugin and gradle plugin.
static void	RpcMarkdownBuilder.buildApiDoc(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) Only for smart-doc maven plugin and gradle plugin.
void	RpcDocBuilderTemplate.buildApiDoc(List<RpcApiDoc> apiDocList, ApiConfig config, String template, String fileExtension) Generate api documentation for all controllers.
void	RpcDocBuilderTemplate.buildErrorCodeDoc(ApiConfig config, String template, String outPutFileName) build error_code adoc
static RpcApiAllData	RpcApiDataBuilder.getApiData(ApiConfig config) Get list of ApiDoc
RpcApiAllData	RpcDocBuilderTemplate.getApiData(ApiConfig config, com.thoughtworks.qdox.JavaProjectBuilder javaProjectBuilder) get all api data