У меня есть API RESTful Spring Boot, который принимает JSON в качестве тела запроса для операций POST. JSON преобразуется в определенные объекты с помощью Jackson ObjectMapper. Поскольку все больше команд используют наш API, нам нужно иметь хорошую документацию, которая актуальна. Я видел Swagger и Spring REST Docs как способы документирования API. Тем не менее, я не видел примера, который был бы полезен для моей ситуации.Документирование кода POJO с помощью аннотаций Javax и проверки Hibernate
У меня много POJO. Все они унаследованы от общего POJO, а некоторые из них имеют множество цепочек наследования. Существует множество разных POJO, которые существуют, и каждый из них представляет собой другое событие. У POJO есть аннотации, такие как @NotNull и другие аннотации ObjectMapper для описания JSON. Мы хотим документировать эти POJO или Модели через код, чтобы у нас всегда была документация, текущая с кодом. Swagger кажется слишком упрощенным для нашего случая, потому что наш API POST принимает множество разных моделей, и я еще не вижу пример онлайн из Spring REST Docs.
В основном, мой вопрос: могу ли я документировать мои POJO с аннотациями через код? Благодаря!
Он не использует аннотации, но Spring REST Docs поддерживает [документирование полезных данных запроса и ответа] (http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting- ваши-api-request-response-payloads) и [их ограничения] (http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting-your-api-constraints) –
Привет, Энди , Я еще не видел пример Весенних REST Docs в Интернете, но я думаю, что это лучше всего подходит для меня. Знаете ли вы о каких-либо примерах весенних REST Docs в действии онлайн? – PhillipAMann
REST Docs сам имеет [несколько образцов] (https://github.com/spring-projects/spring-restdocs/tree/master/samples). Некоторые люди тоже об этом писали. См. Http://info.michael-simons.eu/2015/11/05/documenting-your-api-with-spring-rest-docs/, http://yetanotherdevblog.com/introduction_to_spring_restdocs и https: // medium .com/@ flbenz/beautiful-api-documentation-with-negligible-overhead-2ba523205f61 # .fvvhjp6v0 например. –