Json api doc Controller例子

最新推荐文章于 2024-08-16 08:59:39 发布

ppby2002

最新推荐文章于 2024-08-16 08:59:39 发布

阅读量2.7k

点赞数

CC 4.0 BY-SA版权

分类专栏： Code Snippet 文章标签： jsondoc json文档文档生成 webservice

本文链接：https://blog.youkuaiyun.com/ppby2002/article/details/20136819

Code Snippet 专栏收录该内容

26 篇文章

订阅专栏

本文介绍了一个使用Spring MVC注解实现的API文档生成器，该生成器能够自动生成当前应用的RESTful API文档，包括获取应用程序版本和构建API文档的基本路径。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

@Controller
@RequestMapping(value = "/jsondoc")
public class JSONDocController {
private final static Logger log = LoggerFactory.getLogger(JSONDocController.class);

@Autowired(required=false)
private ServletContext servletContext;

@RequestMapping(method = RequestMethod.GET, produces=MediaType.APPLICATION_JSON_VALUE)
public @ResponseBody
JSONDoc getApi(HttpServletRequest request) {
String version = ApiConfig.getAppVersion();
String basePath = StringUtils.join(
new Object[]{request.getScheme()
, "://"
, request.getServerName()
, ":"
, request.getServerPort()
, request.getContextPath()
, "/"
});

log.info("init doc version [{}], doc path [{}]", version, basePath);

return JSONDocUtils.getApiDoc(servletContext, version, basePath);
}
}