# smart-doc-example-cn

**Repository Path**: justgoahead007/smart-doc-example-cn

## Basic Information

- **Project Name**: smart-doc-example-cn
- **Description**: smart-doc demo，仅为github的同步仓库，pr请前往github
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 21
- **Created**: 2023-07-13
- **Last Updated**: 2023-07-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Smart-doc Samples
本项目是Smart-doc官方开发时的各种代码场景测试示例，由于smart-doc并不需要在项目运行过程中生成文档，最多只是依赖于编译过程。
因此本项目可能并不能正常启动运行，也不可作为学习spring boot的参考项目。
本项目中各种奇怪的代码只是想告诉你，Smart-doc具备应对复杂代码推导生成文档的能力。
其他工具能在该项目上扫描代码生成文档基本也具备了应对大多数公司接口开发文档生成的能力。

# 官方建议
官方建议使用插件的方式来集成使用smart-doc。可参考文档插件使用文档。

[maven插件使用](https://gitee.com/smart-doc-team/smart-doc/wikis/smart-doc%20maven插件?sort_id=1791450)

# 用例内容
代码中涉及到许多代码解析测试，主要包含如下：

- 常见接口返回用例
- 参数JSR303验证，包含普通验证和分组验证
- 包含Jpa分页和国内Mybatis-plus的分页处理例子
- 请求头的各种设置处理
# 意义
这是smart-doc从2018年开源至今收集起来的各种接口书写用例，正因为经过里面各种用例磨炼，
才使得smart-doc在国内成为JAVA API文档工具的领导者，才能获得很好的用户口碑。