{"id":2070,"date":"2024-05-22T12:54:14","date_gmt":"2024-05-22T17:54:14","guid":{"rendered":"https:\/\/readmeprd.wpenginepowered.com\/?p=2070"},"modified":"2024-11-02T17:33:03","modified_gmt":"2024-11-02T22:33:03","slug":"cookin-up-code-samples-with-readme-recipes","status":"publish","type":"post","link":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes","title":{"rendered":"Cookin&#8217; Up Code Samples With ReadMe Recipes"},"content":{"rendered":"\n<p>Getting started with a new API can be complicated. But we don&#8217;t think it has to be! So much time goes into making product onboarding smooth and simple \u2014 shouldn&#8217;t APIs be the same way?<\/p>\n\n\n\n<p>That\u2019s why we built <a href=\"https:\/\/readme.com\/resources\/recipes\" rel=\"noreferrer nofollow noopener\">ReadMe Recipes<\/a>. They&#8217;re a new way to highlight your top API use cases and walk through code samples step by step, so it\u2019s easy for your developers to get started fast. Once you\u2019ve made a Recipe, you can embed it throughout your docs for one-click access on related endpoints or guides.<\/p>\n\n\n\n<style>\n  .kg-card.kg-embed-card {\n    position: relative;\n    width: 100%;\n    padding-bottom: 56.25%; \/* Aspect ratio for 16:9 *\/\n    height: 0;\n    overflow: hidden;\n  }\n  .kg-card.kg-embed-card iframe {\n    position: absolute;\n    top: 0;\n    left: 0;\n    width: 100%;\n    height: 100%;\n    border: 0;\n  }\n<\/style>\n\n<figure class=\"kg-card kg-embed-card\">\n  <iframe src=\"https:\/\/www.youtube.com\/embed\/ssoFq6Bj0zM?feature=oembed\" allowfullscreen=\"allowfullscreen\"><\/iframe>\n<\/figure>\n\n\n\n\n<p>Something we think about a lot at ReadMe is how we can better help customers \u201cshow, not tell\u201d with their docs. Who wants to read paragraphs of text when you could learn faster from a relevant, reusable example?<\/p>\n\n\n\n<p>So we\u2019re applying the same idea here \u2014 instead of going on and on about how Recipes work, here\u2019s the inside scoop from a few customers already cookin\u2019 up new Recipes in their docs \ud83d\udc68\u200d\ud83c\udf73 <em>(And yes, the cooking puns are out of control around here.)<\/em><\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"how-ascend-io-cuts-the-burden-of-data-engineering\">How Ascend.io cuts the burden of data engineering<\/h2>\n\n\n\n<p><a href=\"https:\/\/developer.ascend.io\/recipes\">Ascend.io<\/a>&#8216;s data engineering platform frees up data teams to spend less time maintaining brittle data pipelines and more time innovating. Their flex-code approach democratizes data engineering to help teams build 10X faster and automate maintenance \u2014 all with 95% less code.<\/p>\n\n\n\n<figure class=\"wp-block-image kg-card kg-image-card\"><img decoding=\"async\" src=\"https:\/\/blog.readme.com\/content\/images\/2021\/03\/Ascend-screenshot-1.png\" alt=\"\"\/><\/figure>\n\n\n\n<p>Since Recipes is all about helping developers get started faster, it was right up their alley to start building. As founder and CEO Sean Knapp put it: &#8220;Ascend.io is focused on making data engineering smarter and easier, and using ReadMe Recipes in our documentation is a natural extension of doing just that. With Recipes, we can provide users simple to follow instructions for getting started with and using the platform \u2014 without having to spend hours creating the walkthroughs, which is a crucial time savings for our team.&#8221;<\/p>\n\n\n\n<p>Simpler instructions with less time and effort? Count us in.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"how-typless-takes-the-pain-out-of-data-extraction\">How Typless takes the pain out of data extraction<\/h2>\n\n\n\n<p><a href=\"https:\/\/docs.typless.com\/recipes\">Typless<\/a> only recently started using ReadMe, and Recipes was actually a deciding factor for them when choosing a docs platform.<\/p>\n\n\n\n<p>Their OCR (optical character recognition) API enables their customers to extract complex invoice data in a single call. Despite this simplicity, their Head of AI, Gal Giacomelli, shared that they&#8217;d previously struggled to communicate how easy Typless was to use \u2014 a meta challenge we can all relate to.<\/p>\n\n\n\n<figure class=\"wp-block-image kg-card kg-image-card\"><img decoding=\"async\" src=\"https:\/\/blog.readme.com\/content\/images\/2021\/03\/Typless-screenshot-2.png\" alt=\"\"\/><\/figure>\n\n\n\n<p>After building out more than 15 (!) Recipes to start with, their investment in building a great developer experience is already paying off. Since launching their ReadMe docs site, they&#8217;ve seen a clear uptick in successful first API calls from new customers. That metric is critical for API-first companies, and we can&#8217;t wait to see how Typless continues to innovate.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"how-sendinblue-makes-transactional-emails-a-snap\">How Sendinblue makes transactional emails a snap<\/h2>\n\n\n\n<p><a href=\"https:\/\/developers.sendinblue.com\/recipes\" rel=\"noopener noreferrer\">Sendinblue<\/a> provides marketing automation tools with a focus on scalability, so their platform evolves as businesses grow. Too often, marketing automation platforms fall on one extreme or the other \u2014 incredibly basic or overly complex \u2014 causing costly migrations as an organization matures and their needs change. Sendinblue breaks this cycle by keeping their products flexible for growing teams.<\/p>\n\n\n\n<p>One area in particular that requires customization? Transactional email. Because these notifications are unique to every business, Sendinblue keeps it simple set up the exact triggers developers need. Mauricio Mourraille, the PM for APIs at Sendinblue, shared that once they identified the most common use cases for their SDKs, they used Recipes to ensure actions were executed in the correct order \u2014 from package installation to emails being sent.<\/p>\n\n\n\n<figure class=\"wp-block-image kg-card kg-image-card\"><img decoding=\"async\" src=\"https:\/\/blog.readme.com\/content\/images\/2021\/03\/Sendinblue-layout-2.png\" alt=\"\"\/><\/figure>\n\n\n\n<p>Providing an easy on-ramp for all kinds of developers was key, so Sendinblue created Recipes for the most common code languages their customers use: PHP, Python, and Node. By walking through their top use cases for all three languages, they give their developers a jump start no matter what code language they want (or need) to use.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\"\/>\n\n\n\n<p>Feeling inspired to whip up a Recipe? <em>(Sorry, we can&#8217;t resist <\/em>\ud83e\udd26\u200d\u2642\ufe0f<em>) <\/em><\/p>\n\n\n\n<p>You can set them up anytime right from the \/recipes page of your docs. Your developer community won&#8217;t see them until you hit publish, so feel free to play around! We&#8217;ve got more <a href=\"https:\/\/docs.readme.com\/docs\/recipes\">detailed instructions<\/a> for you in our docs if you need them.<\/p>\n\n\n\n<p>This feature is only available to ReadMe customers, so if you&#8217;re not yet using ReadMe for your docs, you can get started with a free trial <a href=\"http:\/\/dash.readme.com\/signup\">here<\/a>.<\/p>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Getting started with a new API can be complicated. But we don&#8217;t think it has to be! So much time goes into making product onboarding smooth and simple \u2014 shouldn&#8217;t APIs be the same way? That\u2019s why we built ReadMe Recipes. They&#8217;re a new way to highlight your top API use cases and walk through [&hellip;]<\/p>\n","protected":false},"author":6,"featured_media":2060,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"content-type":"","inline_featured_image":false,"footnotes":""},"categories":[24],"tags":[45],"ppma_author":[49],"class_list":["post-2070","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-readme-journey","tag-developer-experience"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v23.0 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Cookin&#039; Up Code Samples With ReadMe Recipes - ReadMe: Resource Library<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Cookin&#039; Up Code Samples With ReadMe Recipes - ReadMe: Resource Library\" \/>\n<meta property=\"og:description\" content=\"Getting started with a new API can be complicated. But we don&#8217;t think it has to be! So much time goes into making product onboarding smooth and simple \u2014 shouldn&#8217;t APIs be the same way? That\u2019s why we built ReadMe Recipes. They&#8217;re a new way to highlight your top API use cases and walk through [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes\" \/>\n<meta property=\"og:site_name\" content=\"ReadMe: Resource Library\" \/>\n<meta property=\"article:published_time\" content=\"2024-05-22T17:54:14+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-11-02T22:33:03+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2021\/03\/banner.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1088\" \/>\n\t<meta property=\"og:image:height\" content=\"343\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Kanad Gupta\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Kanad Gupta\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes\",\"url\":\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes\",\"name\":\"Cookin' Up Code Samples With ReadMe Recipes - ReadMe: Resource Library\",\"isPartOf\":{\"@id\":\"https:\/\/readme.com\/resources\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#primaryimage\"},\"image\":{\"@id\":\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#primaryimage\"},\"thumbnailUrl\":\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2021\/03\/banner.png\",\"datePublished\":\"2024-05-22T17:54:14+00:00\",\"dateModified\":\"2024-11-02T22:33:03+00:00\",\"author\":{\"@id\":\"https:\/\/readme.com\/resources\/#\/schema\/person\/5ff0ec37fac9e314594c7a5564ee24ad\"},\"breadcrumb\":{\"@id\":\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#primaryimage\",\"url\":\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2021\/03\/banner.png\",\"contentUrl\":\"https:\/\/readme.com\/resources\/wp-content\/uploads\/2021\/03\/banner.png\",\"width\":1088,\"height\":343},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/readme.com\/resources\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cookin&#8217; Up Code Samples With ReadMe Recipes\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/readme.com\/resources\/#website\",\"url\":\"https:\/\/readme.com\/resources\/\",\"name\":\"ReadMe: Resource Library\",\"description\":\"Making API documentation better for everyone\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/readme.com\/resources\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/readme.com\/resources\/#\/schema\/person\/5ff0ec37fac9e314594c7a5564ee24ad\",\"name\":\"Kanad Gupta\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/readme.com\/resources\/#\/schema\/person\/image\/f411bab14c6f25f8d94c6658c39badd3\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/e1918540f557e223e19f33cf4db88f78bee3594cbcc066d92c4b609b68123058?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/e1918540f557e223e19f33cf4db88f78bee3594cbcc066d92c4b609b68123058?s=96&d=mm&r=g\",\"caption\":\"Kanad Gupta\"},\"description\":\"Joining us remotely from Minneapolis, Kanad forms the newly-minted Minnesota branch of the ReadMe team! We love Minnesota. Kanad just bought a bike and is loving riding around Minneapolis, but he\u2019s less enthused by the whole peddling aspect of it. While biking around MPLS, Kanad is probably listening to Janelle Mon\u00e1e\u2014his Spotify artist of the decade.\",\"url\":\"https:\/\/readme.com\/resources\/author\/kanad\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Cookin' Up Code Samples With ReadMe Recipes - ReadMe: Resource Library","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes","og_locale":"en_US","og_type":"article","og_title":"Cookin' Up Code Samples With ReadMe Recipes - ReadMe: Resource Library","og_description":"Getting started with a new API can be complicated. But we don&#8217;t think it has to be! So much time goes into making product onboarding smooth and simple \u2014 shouldn&#8217;t APIs be the same way? That\u2019s why we built ReadMe Recipes. They&#8217;re a new way to highlight your top API use cases and walk through [&hellip;]","og_url":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes","og_site_name":"ReadMe: Resource Library","article_published_time":"2024-05-22T17:54:14+00:00","article_modified_time":"2024-11-02T22:33:03+00:00","og_image":[{"width":1088,"height":343,"url":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2021\/03\/banner.png","type":"image\/png"}],"author":"Kanad Gupta","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Kanad Gupta","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes","url":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes","name":"Cookin' Up Code Samples With ReadMe Recipes - ReadMe: Resource Library","isPartOf":{"@id":"https:\/\/readme.com\/resources\/#website"},"primaryImageOfPage":{"@id":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#primaryimage"},"image":{"@id":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#primaryimage"},"thumbnailUrl":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2021\/03\/banner.png","datePublished":"2024-05-22T17:54:14+00:00","dateModified":"2024-11-02T22:33:03+00:00","author":{"@id":"https:\/\/readme.com\/resources\/#\/schema\/person\/5ff0ec37fac9e314594c7a5564ee24ad"},"breadcrumb":{"@id":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#primaryimage","url":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2021\/03\/banner.png","contentUrl":"https:\/\/readme.com\/resources\/wp-content\/uploads\/2021\/03\/banner.png","width":1088,"height":343},{"@type":"BreadcrumbList","@id":"https:\/\/readme.com\/resources\/cookin-up-code-samples-with-readme-recipes#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/readme.com\/resources\/"},{"@type":"ListItem","position":2,"name":"Cookin&#8217; Up Code Samples With ReadMe Recipes"}]},{"@type":"WebSite","@id":"https:\/\/readme.com\/resources\/#website","url":"https:\/\/readme.com\/resources\/","name":"ReadMe: Resource Library","description":"Making API documentation better for everyone","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/readme.com\/resources\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/readme.com\/resources\/#\/schema\/person\/5ff0ec37fac9e314594c7a5564ee24ad","name":"Kanad Gupta","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/readme.com\/resources\/#\/schema\/person\/image\/f411bab14c6f25f8d94c6658c39badd3","url":"https:\/\/secure.gravatar.com\/avatar\/e1918540f557e223e19f33cf4db88f78bee3594cbcc066d92c4b609b68123058?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/e1918540f557e223e19f33cf4db88f78bee3594cbcc066d92c4b609b68123058?s=96&d=mm&r=g","caption":"Kanad Gupta"},"description":"Joining us remotely from Minneapolis, Kanad forms the newly-minted Minnesota branch of the ReadMe team! We love Minnesota. Kanad just bought a bike and is loving riding around Minneapolis, but he\u2019s less enthused by the whole peddling aspect of it. While biking around MPLS, Kanad is probably listening to Janelle Mon\u00e1e\u2014his Spotify artist of the decade.","url":"https:\/\/readme.com\/resources\/author\/kanad"}]}},"authors":[{"term_id":49,"user_id":6,"is_guest":0,"slug":"kanad","display_name":"Kanad Gupta","avatar_url":"https:\/\/secure.gravatar.com\/avatar\/e1918540f557e223e19f33cf4db88f78bee3594cbcc066d92c4b609b68123058?s=96&d=mm&r=g","first_name":"Kanad","last_name":"Gupta","position":"Developer Advocate & API Engineer","slogan":"Developer Advocate &amp; API Engineer (he\/him)","description":"Joining us remotely from Minneapolis, Kanad forms the newly-minted Minnesota branch of the ReadMe team! We love Minnesota.\r\n\r\nKanad just bought a bike and is loving riding around Minneapolis, but he\u2019s less enthused by the whole peddling aspect of it. While biking around MPLS, Kanad is probably listening to Janelle Mon\u00e1e\u2014his Spotify artist of the decade."}],"_links":{"self":[{"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/posts\/2070","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/comments?post=2070"}],"version-history":[{"count":0,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/posts\/2070\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/media\/2060"}],"wp:attachment":[{"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/media?parent=2070"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/categories?post=2070"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/tags?post=2070"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/readme.com\/resources\/wp-json\/wp\/v2\/ppma_author?post=2070"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}