APIs in a modern enterprise are rarely uniform or all of the same type. The multitude of API types can be due to organic growth, mergers and acquisitions, or any number of other reasons. Regardless of their origin, APIs of all types need to be fully documented to facilitate a developer’s journey as they interact with your API ecosystem in order to develop useful applications. In this talk I will show examples of how we have augmented developer portals to document APIs that are not of the REST variety, such as AsyncAPI, GraphQL, SOAP, gRPC, and more, such that all API documentation can seamlessly live side-by-side.

1. THIS IS YOUR
PRESENTATION
(or slidedoc) title
One Developer
Portal to
Document Them
All
Christoph Weber
Solutions Architect
┃1

2. Hello!
Nice to meet you
Contact
▪ Christoph Weber
▪ www.pronovix.com
▪ christoph.weber@pronovix.com
▪ LinkedIn:
linkedin.com/in/christophweber/
I work as a Solutions Architect and general
loudmouth at Pronovix.
┃2

3. “
APIs in a modern enterprise
are rarely uniform or all of
the same type.

4. APIs in a modern enterprise
are rarely uniform or all of
the same type.
Organic Growth

5. APIs in a modern enterprise
are rarely uniform or all of
the same type.
Mergers & Acquisitions

6. APIs in a modern enterprise
are rarely uniform or all of
the same type.
Specific Technical Needs

7. APIs in a modern enterprise
are rarely uniform or all of
the same type.
Misc. other reasons

8. Result

9. Goal

10. “
Once a company decides to fully manage
and document their APIs, put emphasis on
an API-first strategy, and streamline digital
governance, they start looking for a
developer portal that can support their
needs.

11. Let's look at what is possible
with examples.

12. REST
SwaggerUI
┃12

13. REST
Description
Landing Page
┃13

14. REST
Tutorial etc.
┃14

15. AsyncAPI
Specification
┃15

16. AsyncAPI
Specification
Cont.
┃16

17. GraphQL
Playground
┃17

18. SOAP
Bespoke
documentation
┃18

19. gRPC
Documentation
┃19

20. Everything
Else
┃20
There are many more API types in use, and
more are added every year.
Most modern API ecosystems have tooling
to output MarkDown or HTML for
documentation purposes …
… input into a developer portal is
straightforward

21. Conclusion
A large variety of
API types and
protocols can be
documented in a
single, cohesive
developer portal in
a straightforward
and visually
appealing way.
Complexity?
What Complexity?