Ich habe eine Spring Boot RESTful-API, die einen JSON als den Anfragekörper für POST-Operationen akzeptiert. Der JSON wird mithilfe eines Jackson ObjectMappers in bestimmte Objekte konvertiert. Da immer mehr Teams unsere API verwenden, benötigen wir eine aktuelle Dokumentation. Ich habe Swagger und Spring REST Docs als Möglichkeit gesehen, eine API zu dokumentieren. Ich habe jedoch kein Beispiel gesehen, das für meine Situation hilfreich ist.Dokumentieren von POJO-Code mit Javax-Annotationen und Hibernate-Validierung
Ich habe viele POJO's. Sie alle sind von einem gemeinsamen POJO geerbt und einige haben viele Erbketten. Es gibt viele verschiedene POJOs, die jeweils ein anderes Ereignis darstellen. Die POJOs enthalten Annotationen wie @NotNull und andere ObjectMapper-Annotationen, um den JSON zu beschreiben. Wir möchten diese POJOs oder Modelle durch Code dokumentieren, so dass wir immer Dokumentation haben, die mit dem Code aktuell ist. Swagger scheint für unseren Fall zu einfach zu sein, da unsere POST-API viele verschiedene Modelle akzeptiert und ich noch nicht einmal ein Beispiel von Spring REST Docs online gesehen habe.
Also im Grunde ist meine Frage: Kann ich meine POJOs mit Anmerkungen durch Code dokumentieren? Vielen Dank!
Es verwendet keine Anmerkungen, aber Spring REST Docs unterstützt [Dokumentierung von Nutzdaten für Anforderungen und Antworten] (http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documentation- Ihre api-request-response-Nutzdaten) und [ihre Einschränkungen] (http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#documenting-your-api-constraints) –
Hallo Andy , Ich habe noch ein Beispiel für Spring REST Docs online gesehen, aber ich denke, dass es die beste Lösung für mich ist. Kennen Sie Beispiele für Spring REST Docs in Aktion online? – PhillipAMann
REST Docs selbst hat [mehrere Beispiele] (https://github.com/spring-projects/spring-restdocs/tree/master/samples). Mehrere Leute haben darüber auch gebloggt. Siehe http://info.michael-simons.eu/2015/11/05/documentation-your-api-with-spring-rest-docs/, http://yetanotherdevblog.com/introduction_to_spring_restdocs und https: // medium .com/@ flbenz/beautiful-api-Dokumentation-mit-vernachlässigbar-Overhead-2ba523205f61 # .fvvhjp6v0 zum Beispiel. –