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

[management-api] generate api descriptor with swagger #184

Closed
NicolasGeraud opened this Issue Aug 3, 2016 · 5 comments

Comments

Projects
None yet
3 participants
@NicolasGeraud
Member

NicolasGeraud commented Aug 3, 2016

  • use swagger to document gravitee api
    • generate descriptor during build
    • allow users to download this descriptor from website (using bintray ?)
    • generate postman collection with this descriptor
    • allow users to download this collection from website (using bintray?)
@tcompiegne

This comment has been minimized.

Member

tcompiegne commented Aug 3, 2016

That will be useful to generate the API AsciiDoc documentation :

https://github.com/Swagger2Markup/swagger2markup

@brasseld

This comment has been minimized.

Member

brasseld commented Aug 3, 2016

Does it mean that we have to generate README.adoc using this plugin ?

@tcompiegne

This comment has been minimized.

Member

tcompiegne commented Aug 3, 2016

Maybe an API.adoc that we can deploy to :

https://docs.gravitee.io/api

@NicolasGeraud

This comment has been minimized.

Member

NicolasGeraud commented Aug 4, 2016

+1 for an api.adoc

But the goal is to release the api.adoc with the management-api repo, right ?
And include this .adoc into the actual documentation website or into a new one.

@brasseld

This comment has been minimized.

Member

brasseld commented Aug 4, 2016

👍 for api.adoc

But, IMHO, it should not be included in documentation website. We must provide a dedicated and versioned page for it.

brasseld added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Aug 29, 2016

@NicolasGeraud NicolasGeraud added this to the 0.19.0 milestone Sep 1, 2016

brasseld added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Sep 4, 2016

brasseld added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Sep 6, 2016

brasseld added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Sep 6, 2016

brasseld added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Sep 6, 2016

brasseld added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Sep 6, 2016

NicolasGeraud added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Sep 6, 2016

NicolasGeraud added a commit to gravitee-io/gravitee-management-rest-api that referenced this issue Sep 6, 2016

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