9:09 a.m.
Hello,
We plan to use APICurio in our project to enfore contract-first api development. I have a
few questions related to that
1. How do we integrate the validation rules from apicurio studio in the build pipeline (we
use jenkins as our continuous integration server)? Can the build fail if the spec doesn’t
pass critical validation rules?
2. How do we combine multiple API specs from multiple projects to show up on a central
documentation serv
9:12 a.m.
Sorry my email got pushed in an incomplete state. Rephrasing the second question
2. How do we combine multiple API specs from multiple projects to show up on a central
documentation server? Does APIcurio integrate with api documentation tools (redoc?)
Thanks.
11:48 a.m.
Thank you for the questions.
1. Currently you would need to do something custom to accomplish this,
although it should not be difficult to achieve. The validation we use in
Studio is included in the standalone library called apicurio-data-models
found here: https://github.com/Apicurio/apicurio-data-models I would be
happy to point you in the right direction on this. But we don't have a
standalone tool that can do this for you already.
2. Apicurio Studio and Apicurio Registry both have ReDoc integrated. You
could use Apicurio Registry *as* your centralized documentation server,
although it's meant as more of an internal catalog rather than an external
facing documentation server. So if you're looking for the latter (e.g.
some sort of API Portal) we don't have a solution for that.
On Fri, Jun 25, 2021 at 10:12 AM Jgeek Jgeek via Apicurio <
apicurio(a)lists.jboss.org> wrote:
Sorry my email got pushed in an incomplete state. Rephrasing the
second
question
2. How do we combine multiple API specs from multiple projects to show up
on a central
documentation server? Does APIcurio integrate with api documentation tools
(redoc?)
Thanks.
_______________________________________________
Apicurio mailing list -- apicurio(a)lists.jboss.org
To unsubscribe send an email to apicurio-leave(a)lists.jboss.org
--
Eric Wittmann
Principal Software Engineer - Apicurio - Red Hat
He / Him / His
eric.wittmann(a)redhat.com
1033
days inactive
1036
days old
2 comments
2 participants
participants (2)
-
Eric Wittmann -
Jgeek Jgeek