Resteasy – 从Javadoc和Annotations生成REST文档

我想找到一种方法从 Java

代码(WADL或HTML)生成漂亮的REST API文档 – 基于JAXB,JAX-RS注释java doc注释(请不要doclet).

这是我的项目环境

> Spring,没有XML注释

> Rest-easy作为REST提供者

> JAXB和JAX-RS注释

> Mime用于JSON中的rest API

试试 Enunciate
.

Enunciate is an engine for dramatically enhancing your Java Web service API.

It’s simple. You develop your Web service API using standard Java technologies and attach Enunciate to your build process. Suddenly, your Web service API is boasting some pretty impressive features:

  • Full HTML documentation of your services, scraped from your JavaDocs.
  • Client-side libraries (e.g. Java, .NET, iPhone, Ruby, Flex, AJAX, GWT, etc.) for developers who want to interface with your API.
  • Interface Definition Documents (e.g. WSDL, WADL, XML-Schema, etc.)
  • Etc.

翻译自:https://stackoverflow.com/questions/8709622/resteasy-generate-rest-documentation-from-javadoc-and-annotations

原文 

https://codeday.me/bug/20190112/514959.html

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » Resteasy – 从Javadoc和Annotations生成REST文档

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址