REST WADL: какие-нибудь рекомендации по стилю или хорошие примеры? - PullRequest
Новая
       18

REST WADL: какие-нибудь рекомендации по стилю или хорошие примеры?

0 голосов
/ 22 декабря 2010

Существует множество отличных примеров и рекомендаций (см. Ссылку [1]) для написания хорошего javadoc для кода Java

Мы документируем наши REST-интерфейсы через WADL, используя 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. e, g, мы не хотим дублировать информацию, которая подразумевается в глаголе HTTP или URL.

Ссылка 1. Как написать комментарии к документу для инструмента Javadoc. Я не могу добавить URL, поскольку я новый пользователь, но я имею в виду рекомендации на
www.oracle.com/technetwork/java/javase/documentation/index-137868.html

1 Ответ

0 голосов
/ 22 декабря 2010

Единственная часть системы RESTful, которая нуждается в какой-либо дополнительной документации, - это пользовательские типы носителей и пользовательские отношения ссылок.

Подумайте об этом, какую документацию вы предоставили поставщикам веб-браузеров, чтобы пользователи могли получить доступ к вашему корпоративному веб-сайту?

...