One is the front end or a user interface that is visible to the audience. And, hey, if you want to resolve the linked assets and entries yourself, then you’re well equipped.Ĭheck out some further reading on how you can resolve linked assets and entries from the Contentful Rich Text field response in both the REST API and GraphQL API.Īnd remember, build stuff, learn things and love what you do.Each website has two sides. Understanding the structure of the data responses from Contentful and how linked assets are returned and then resolved via the Contentful SDKs, empowers you to choose which APIs and methods are best suited to your applications.
Read more about GraphQL complexity limits here. There’s always the caveat, however, that a complex GraphQL query with many nested link assets and entries might surpass the maximum complexity permitted on the GraphQL API. In comparison to the REST API, where you usually fetch the blog post data and link the entries after the fact, a GraphQL API query is entirely flexible to your needs. The include depth is inferred by the construction of your GraphQL query In the response above, the data for author appeared in the node tree exactly where we expected it, and we can access the name on the front end - for example, via .name - without having to use an SDK to resolve the entries. Here’s the GraphQL query that we would use to fetch the same blog post data with the author name and image as referenced in the first example: Technically, if you construct your query cleverly, you can reach data hundreds of levels deep! Read more about GraphQL complexity limits here. The only limit here is the complexity of your GraphQL query. With GraphQL you specify the equivalent depth of the includes response through the construction of your query.The response from the GraphQL API gives you a rich object graph as standard (so you won’t find includes in the response).The main differences between the REST API and GraphQL API The Contentful GraphQL API doesn’t require an SDK to handle linked entries - but understanding the concepts covered previously helps us out here. Read more about the include param on the Contentful docs. Regardless of the include depth you specify - the SDK - which uses the contentful-resolve-response package, will link all available and responded entries and assets that are returned in the includes response. The example blog post is served on an application built with Next.js - but we won’t be going into Next.js in this post.Įnter fullscreen mode Exit fullscreen mode The following examples focus on using the JavaScript ecosystem to query data from this example blog post. And by understanding how the REST API works and how the SDKs resolve links, you’ll be all set.
If you’re using the GraphQL API, you control how your entries are resolved in the construction of your GraphQL query. In this example, we’ll be taking a look at the JavaScript SDK. These will resolve your linked entries and assets for you. If you’re using the Content Delivery and Content Preview REST API, Contentful provides a number of SDKs (Software Development Kits) in the most popular programming languages. The screenshot of the blog post content model below shows that the Author field is a Reference field type, which is a link. Here’s the content model that we’ll be working with in this article. For more information on the concept of links in Contentful, visit the documentation. You can liken this to working with relational databases, where you would define one to one or one to many relationships within your data structures or models. Entries in Contentful can contain link fields that point to other assets or entries, and those entries can link to other assets or entries, and so on. Links are Contentful’s way of modelling relationships between content types and entries.
#Contentful json editor how to#
If you’re looking for information on how to render linked assets and entries returned as part of the Contentful Rich Text field response using REST or GraphQL in JavaScript, check out this post. It’s no secret that those of you who tuned in to my Twitch streams after I had started at Contentful saw me struggle with the concept of links as well! So, I set out to explore and investigate the inner workings of the Contentful REST API and GraphQL API in terms of linking assets and entries on a content type in order to understand how we can render links inside Contentful Rich Text fields. The most frequently asked questions in DevRel when I started with Contentful were about how to display links or linked entries and assets inside the Contentful Rich Text field on the front end.
0 kommentar(er)
