REST WADL：有什么风格指南或好的例子吗？

发布于 2024-10-08 18:48:53 字数 933 浏览 4 评论 0原文

有很多优秀的示例和指南（请参阅参考文献 [1]）用于为 Java 代码编写良好的 javadoc

通过 WADL 记录我们的 REST 接口

我们正在使用 Restlet http://wiki.restlet.org/docs_2.0/13-restlet/28-restlet/72-restlet.html

引用该教程，我们添加了如下代码...

 @Override
    protected void describeDelete(MethodInfo info) {
        info.setDocumentation("Delete the current item.");

        RepresentationInfo repInfo = new RepresentationInfo();
        repInfo.setDocumentation("No representation is returned.");
        repInfo.getStatuses().add(Status.SUCCESS_NO_CONTENT);
        info.getResponse().getRepresentations().add(repInfo);
    }

是否有良好的简洁 WADL 的编码标准或示例。例如，我们不想重复 HTTP 动词或 URL 中隐含的信息。

参考 1. 如何为 Javadoc 工具编写文档注释。我无法添加 URL，因为我是新用户，但我的意思是指南位于
www.oracle.com/technetwork/java/javase/documentation/index-137868.html

原文

There are plenty of excellent examples and guidelines (see ref [1]) for writing good javadoc for Java code

We are documenting our REST interfaces via WADL using Restlet

http://wiki.restlet.org/docs_2.0/13-restlet/28-restlet/72-restlet.html

Quoting that tutorial we are adding code like ...

 @Override
    protected void describeDelete(MethodInfo info) {
        info.setDocumentation("Delete the current item.");

        RepresentationInfo repInfo = new RepresentationInfo();
        repInfo.setDocumentation("No representation is returned.");
        repInfo.getStatuses().add(Status.SUCCESS_NO_CONTENT);
        info.getResponse().getRepresentations().add(repInfo);
    }

Are there coding standards or examples of good succinct WADL . e,g, we dont want to duplicate info that is implicit in the HTTP verb or the URL.

Ref 1. How to Write Doc Comments for the Javadoc Tool.
I cant add the URL as I am new user but I mean the guidelines at
www.oracle.com/technetwork/java/javase/documentation/index-137868.html

分享到QQ

分享到微博