Properties Appendix

smalldoc提供了smalldoc-spring-boot-starter，使得spring-boot项目可以快速集成该工具。

这里是smalldoc-spring-boot-starter的相关属性配置，包含.yml与.properties两种使用形式。相关类【SmallDocProperties】

名词解释

• 库类型
• 文档化类
• 非文档化类

使用YAML配置外部属性

application.yml

spring: 
  profiles:
    active: dev # spring-boot的配置，指定激活某些配置文件，支持以逗号分割的数组，这里至少要包含dev。
    
---
spring:
  profiles: dev # spring-boot的配置，为当前配置命名。这里必须为dev —— 表明smalldoc只在开发环境下被启用。
smalldoc:
  enabled: true # 是否启用smalldoc，默认为true
  urlPattern: /smalldoc/* # 作为 SmalldocServlet 的 URLMappings，默认为‘/smalldoc/*’
  project-name: smalldoc # 作为 smalldoc UI界面的title，默认为‘smalldoc’
  name-regex:  # 指定`文档化类`其它类名形式，支持正则表达式。该配置可以提高文档的生成速度。默认只解析以‘Controller’结尾的类。
  library-type-packages: # 为smalldoc指定额外的库类型，值为包的完全限定名，包及子包中的所有类都被认定为库类型。
     -
  library-type-qualified-names: # 为smalldoc指定额外的库类型，指定类都被认定为库类型。
     -
  packages: # 包的完全定名。从指定包以及它们的子包中生成文档。这些包只需要包含`文档化类`。默认值为`/` —— 所有包。该配置可以提高文档的生成速度。
     - /
  source-paths: # 生成文档所需源码的绝对路径(`文档化类`与`非文档化类`都需要包含在这些路径中)。
  # 如果该路径是一个目录，那么将获取目录及子目录中的所有源码，
  # 包括类、sources-jar、sources-war，甚至是sources-zip等压缩文件中的源码，为了保证解析性能，请最小化该路径。
  # 该属性是smalldoc支持多模块项目、第三方依赖、微服务集成文档的基础。
  # 如果你没有配置该路径，那么它将默认为`System.getProperty("user.dir")+/src/main/java`(UNIX)或`System.getProperty("user.dir")+\src\main\java`(Windows)
     - 
     

使用Properties配置外部属性

在SpringBoot项目中，作者更喜欢使用 YAML 做外部配置，因为 .properties 显得并不是很灵活，比如，实现上述 application.yml ，你可能需要两个 .properties 文件。

application.properties

spring.profiles.active=dev # spring-boot的配置，指定激活某些配置文件，支持以逗号分割的数组，这里至少要包含dev。

application-dev.properties

  smalldoc.enabled=true # 是否启用smalldoc，默认为true
  
  smalldoc.urlPattern=/smalldoc/* # 作为 SmalldocServlet 的 URLMappings，默认为‘/smalldoc/*’
  
  smalldoc.project-name=smalldoc # 作为 smalldoc UI界面的title，默认为‘smalldoc’
  
  smalldoc.name-regex= # 指定`文档化类`其它类名形式，支持正则表达式。该配置可以提高文档的生成速度。默认只解析以‘Controller’结尾的类。
  
  smalldoc.library-type-packages=  # 为smalldoc指定额外的库类型，值为包的完全限定名，包及子包中的所有类都被认定为库类型。
  
  smalldoc.library-type-qualified-names= # 为smalldoc指定额外的库类型，指定类都被认定为库类型。
  
  smalldoc.packages=/ # 包的完全定名。从指定包以及它们的子包中生成文档。这些包只需要包含`文档化类`。默认值为`/` —— 所有包。该配置可以提高文档的生成速度。
  
  smalldoc.source-paths= # 生成文档所需源码的绝对路径(`文档化类`与`非文档化类`都需要包含在这些路径中)。
  # 如果该路径是一个目录，那么将获取目录及子目录中的所有源码，
  # 包括类、sources-jar、sources-war，甚至是sources-zip等压缩文件中的源码，为了保证解析性能，请最小化该路径。
  # 该属性是smalldoc支持多模块项目、第三方依赖、微服务集成文档的基础。
  # 如果你没有配置该路径，那么它将默认为`System.getProperty("user.dir")+/src/main/java`(UNIX)或`System.getProperty("user.dir")+\src\main\java`(Windows)