Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document public API using Spring REST Docs #1191

Open
snicoll opened this issue Mar 2, 2021 · 2 comments
Open

Document public API using Spring REST Docs #1191

snicoll opened this issue Mar 2, 2021 · 2 comments

Comments

@snicoll
Copy link
Contributor

snicoll commented Mar 2, 2021

Our endpoints should be documented using Spring REST docs to clarify usage expecations.

@10xtechie
Copy link

@snicoll ,
Is it still needed to be implemented? If so, please assign it to me :)
Is it needed for initializr-web only ?

@snicoll
Copy link
Contributor Author

snicoll commented Jul 12, 2022

Thanks for the offer. Yes, I'd actually like to get rid of Spring Cloud Contract and move those tests to use Spring REST Docs. This should handle the endpoints that are currently documented (see the includes in the .adoc files).

Unfortunately, our test hierarchy is a bit messy at the moment so that's why we never got to it. If you want to give it a try, that would be most welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants