JavaScript disabled You need to activate JavaScript in order to use OpenProject! Learn more
Added by Thomas Ohms over 7 years ago
Hi there,
Is there a Swagger API documentation available to use?
Hi Thomas,
there is no Swagger API documentation (the API documentation is written in the API Blueprint format). You can however easily render the API using Aglio (It should also be possible to convert API Blueprint to Swagger.)
Alternatively, you can take a look at our online documentation at http://docs.openproject.org/apiv3-doc/.
I’m not used to Blueprint and Aglio so sorry for maybe stupid question: Is there a final .md-file anywhere?
Just asking because I’ve even found some better tool, but it needs final Markdown files.
Unfortunately there is not a final Markdown file. There is only a Blueprint file that includes the other files.
I am not into api blueprint documentation, but I think your documentation is lacking the return type model definition.
shouldn’t it look more like this: https://apiblueprint.org/documentation/examples/14-json-schema.html or https://apiblueprint.org/documentation/examples/10-data-structures.html
i tried to convert the apib documentation with api2swagger but it’s not working, all methods have no return value.
something like https://github.com/kminami/apib2swagger might help (not tried yet)
Replies (5)
Hi Thomas,
there is no Swagger API documentation (the API documentation is written in the API Blueprint format).
You can however easily render the API using Aglio
(It should also be possible to convert API Blueprint to Swagger.)
Alternatively, you can take a look at our online documentation at http://docs.openproject.org/apiv3-doc/.
I’m not used to Blueprint and Aglio so sorry for maybe stupid question: Is there a final .md-file anywhere?
Just asking because I’ve even found some better tool, but it needs final Markdown files.
Unfortunately there is not a final Markdown file.
There is only a Blueprint file that includes the other files.
I am not into api blueprint documentation, but I think your documentation is lacking the return type model definition.
shouldn’t it look more like this:
https://apiblueprint.org/documentation/examples/14-json-schema.html
or
https://apiblueprint.org/documentation/examples/10-data-structures.html
i tried to convert the apib documentation with api2swagger but it’s not working, all methods have no return value.
something like https://github.com/kminami/apib2swagger might help (not tried yet)