GraphQL Isn’t An Excuse To Stop Writing Docs by Roy Derks, API The Docs Virtual 2022
About the speak:
The important purpose of API documentation is to assist builders perceive learn how to use an API. With GraphQL, builders usually assume it is self-documenting capabilities are enough for anybody that consumes their GraphQL API. But did you ever validate this?
Good API documentation affords each static and interactive methods to discover ways to eat the API. API’s that assist GraphQL usually solely include interactive documentation, within the form of a GraphiQL Playground. However, the primary time you (or your customers) use a GraphQL API may be very irritating as GraphQL APIs sometimes solely have an interactive playground. it will increase the complexity for newcomers to GraphQL because it assumes you’re already accustomed to GraphQL. But with GraphQL, you’re not restricted to only an interactive playground, as you’ll be able to create static or interactive documentation subsequent to having this playground. This speak explores which types of documentation you should use and the way they add worth to your GraphQL API.
About the writer:
Roy is an entrepreneur, speaker and writer from The Netherlands and, in his personal phrases, ‘needs to make the world a greater place via tech. He has been giving talks and trainings to builders worldwide on applied sciences like GraphQL, React and TypeScript. Most just lately he wrote the e-book Fullstack GraphQL.
—
API the Docs is an occasion for tech writers, API builders, product homeowners and developer evangelists who embrace documentation as a vital facet of a fantastic developer expertise. The convention is a superb alternative to share and focus on the newest finest practices, methods and new traits related to API documentation and developer portals.
Pronovix Developer Portals Newsletter: http://bit.ly/devportals
source
