From the course: Learning GraphQL

Unlock this course with a free trial

Join today to access over 24,900 courses taught by industry experts.

Writing schema documentation

Writing schema documentation - GraphQL Tutorial

From the course: Learning GraphQL

Writing schema documentation

- [Instructor] Our GraphQL project is really coming together here. We have our lift type, we have our trail type, we have a bunch of different mutations and queries, and then the resolvers are doing the hard work of returning all of the data from wherever it lives. Remember, these resolver functions can go get data from rest APIs, from databases, from various cloud services. So when you start to write your resolvers, just know that you can use them to wrap your existing data wherever it might be. So I feel good about this, it's looking great. Now is the moment where we can talk about how we can add documentation to our schema. When we take a look at the server running over here on local host 4000, we know that the explorer is going to do a lot of the work of building the schema for us. So just in the nature of the schema definition language itself, it's giving us a lot of visibility into what fields are available on that type. But we can take this one step farther. We can take the…

Contents