{"id":10953,"date":"2020-09-09T06:33:00","date_gmt":"2020-09-09T06:33:00","guid":{"rendered":"https:\/\/codeandpepper.com\/?p=10953"},"modified":"2020-11-29T16:18:43","modified_gmt":"2020-11-29T16:18:43","slug":"api-developer-experience","status":"publish","type":"post","link":"https:\/\/codeandpepper.com\/api-developer-experience\/","title":{"rendered":"API Developer Experience: Tricks of the Trade"},"content":{"rendered":"\n<p>From data aggregators at the core of open banking to <a href=\"https:\/\/codeandpepper.com\/2020\/07\/14\/online-payment-processing-companies\/\" target=\"_blank\" rel=\"noreferrer noopener\">payment processors<\/a> for digital marketplaces &#8211; many FinTech products deliver value through application programming interfaces (aka APIs). In those cases, it\u2019s hard to speak of User Experience as such. What becomes important then is <strong>Developer Experience<\/strong> (DX), which reflects how easy it is to work and integrate with an API. This in turn, can have a huge impact on the final quality and scalability of the API product. So if your goal is to build a highly-performant, future-proof and integration-ready solution, don&#8217;t forget about Developer Experience. Use the pro tips below to accelerate and empower your <a href=\"https:\/\/codeandpepper.com\/services\/api-development\/\">API development<\/a> process.<\/p>\n\n\n\n<!--more-->\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-developers-in-the-api-economy\">Developers in the API economy<\/h2>\n\n\n\n<p>A standard API lifecycle often takes the form of an infinity loop, with two main agents putting things in motion:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><em>API providers<\/em>, responsible for planning, building, documenting, testing, deployment and management.<\/li><li><em>API consumers<\/em>, who discover, implement, optimise, monitor, and maintain integration.<\/li><\/ul>\n\n\n\n<p>Decisions made by the providers have direct consequences for the consumers, especially in terms of discovery and implementation. On the other hand, the consumers\u2019 feedback is what fuels versioning and enables future improvements.<\/p>\n\n\n\n<div class=\"wp-block-image\"><figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"533\" src=\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-1024x533.png\" alt=\"API Lifecycle DX\" class=\"wp-image-11814\" srcset=\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-1024x533.png 1024w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-300x156.png 300w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-768x400.png 768w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-361x188.png 361w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-192x100.png 192w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-720x375.png 720w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-864x450.png 864w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1-432x225.png 432w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/09\/api_lifecycle-1.png 1200w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><figcaption>Simplified view of a typical API lifecycle<\/figcaption><\/figure><\/div>\n\n\n\n<p><b><strong>Developers<\/strong> play a crucial role in the <strong>API economy<\/strong>, because they are both creators and technical adopters of software products<\/b>. Their influence stretches from each line of code to buying decisions about the solutions that organizations plan to implement. In this context, good Developer Experience is not only a measure of technological efficiency. It can also determine the <b>commercial value and marketability of <strong>API products<\/strong><\/b>, especially if you opt for <a href=\"https:\/\/codeandpepper.com\/case-studies\/legaltech-design-development-oathello\/\" target=\"_blank\" rel=\"noreferrer noopener\">API-first approach<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-developer-experience-in-api-development-tips-tools\">Developer Experience in API development: tips &amp; tools<\/h2>\n\n\n\n<p>Although each <a href=\"https:\/\/codeandpepper.com\/2020\/01\/10\/software-development-process\/\" target=\"_blank\" rel=\"noreferrer noopener\">development project<\/a> is unique in terms of scale and complexity, a set of good practices can help you build an optimal Developer Experience and tailor it to your specific needs. When paired with the right toolset, a DX strategy can not only elevate the final product but also <b>speed up development and facilitate change management<\/b>.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-api-is-only-as-good-as-its-documentation\">API is only as good as its documentation&#8230;<\/h3>\n\n\n\n<p>What might strike you as a bold statement is actually a common belief among seasoned engineers. This <b>combination of technical writing, code samples and use cases<\/b> is the first point of contact and a regular point of reference for all users\/consumers of your API. So if they struggle to understand the <b>purpose and main functions<\/b> of the product, you might be in real trouble. Even the most revolutionary idea can be nipped in the bud if it&#8217;s not successfully communicated to the target audience.<\/p>\n\n\n\n<p>Let\u2019s start with just <b>one page<\/b> where developers can find all the essential information about your API. Even if you have several pages with various development-related resources, try to chain them with global navigation. Plan the directory strategically and make sure to cover all fundamentals:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>authentication<\/li><li>errors<\/li><li>end points<\/li><li>terms of use<\/li><li>changelog<\/li><li>request-response cycle<\/li><\/ul>\n\n\n\n<p>Developers should be able to quickly learn what to expect from a successful call and get an idea of <a href=\"https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Status\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">sample responses and supported formats<\/a>. For exceptional DX, consider including HTTP response status codes and error descriptions.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-language-terminology\">Language &amp; terminology<\/h3>\n\n\n\n<p>Finding the right language to introduce users to your API is equally important. Make sure the documentation is <b>accurate, up-to-date, clear, and concise<\/b>. On that note, it\u2019s risky to assume your audience is 100% developers. Make room for other decision makers: <\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><em>Project Managers<\/em>, wondering whether the API can solve a given problem.<\/li><li><em>Lead Engineers<\/em> and <em>CTOs<\/em>, evaluating the API in the context of their business needs.<\/li><\/ul>\n\n\n\n<p>Not all users are fully familiar with domain jargon, so try to <b>provide enough context for API-specific terminology<\/b>.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-openapi-swagger\">OpenAPI\/Swagger<\/h3>\n\n\n\n<p>Speaking of documentation, manually updated PDFs or static web pages are definitely a thing of the past. Modern API frameworks such as <a href=\"https:\/\/swagger.io\/solutions\/getting-started-with-oas\/\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">Swagger<\/a> and OpenAPI Specification (OAS), used for designing and building APIs, include features enabling <b>automated documentation flow<\/b>. With OAS, developers get a common description format, building blocks for <b>generating and customising interactive API docs<\/b>, as well as other handy features, such as adding sample requests and responses. OpenAPI\/Swagger is considered standard in documenting REST APIs. Most developers are familiar with it and will expect it within the developer documentation.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-the-power-of-experimentation\">The power of experimentation<\/h3>\n\n\n\n<p>Another good practice is to provide a <b>sandbox environment<\/b>, where developers can quickly check how the API is working. If you <b>fill it with a set of test data<\/b>, they don\u2019t have to waste time on setup and can start experimenting straight away. Going a step further, you can also use <a href=\"https:\/\/developer.fountain.com\/docs\/custom-integrations\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">cURL<\/a> to include sample requests, which can be copied and immediately tested for responses.<\/p>\n\n\n\n<p><b>Step-by-step instructions, showing how the API could be used in a valid sequence, can significantly speed up integration<\/b>. Tutorials and guides are mighty knowledge-sharing tools and should be an integral part of API documentation. By the rule of thumb, it\u2019s best when they\u2019re both comprehensive and focused. From the developer\u2019s perspective, general flows and data models might be more vital than the exact details of each end point.<\/p>\n\n\n\n<figure class=\"wp-block-image alignwide size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"956\" height=\"446\" src=\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials.png\" alt=\"API DX tutorials LUSID\" class=\"wp-image-10961\" srcset=\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials.png 956w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials-300x140.png 300w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials-768x358.png 768w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials-361x168.png 361w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials-200x93.png 200w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials-720x336.png 720w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials-864x403.png 864w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/lusid-api-tutorials-432x202.png 432w\" sizes=\"auto, (max-width: 956px) 100vw, 956px\" \/><figcaption><a href=\"https:\/\/codeandpepper.com\/case-studies\/nearshore-it-outsourcing-lusid\/\" target=\"_blank\" rel=\"noreferrer noopener\">LUSID<\/a> is an investment data machine with an API in its core. It includes a series of tutorials showing how to use the API to perform common operations.<\/figcaption><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-need-a-rest-postman-to-the-rescue\">Need a REST? Postman to the rescue!<\/h3>\n\n\n\n<p>In RESTful APIs, Developer Experience can be poor if the API is not quite as REST as it should be&#8230; And it\u2019s more often the case than you\u2019d expect. For more guidance, you can use the <a href=\"https:\/\/martinfowler.com\/articles\/richardsonMaturityModel.html\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">Richardson Maturity Model<\/a>, which describes different levels of an API being REST. Make sure that you are at least at Level 2 called <b>HTTP Verbs<\/b>.<\/p>\n\n\n\n<p><a href=\"https:\/\/www.postman.com\/use-cases\/api-first-development\/\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">Postman<\/a> is a comprehensive tool that helps developers and <a href=\"https:\/\/codeandpepper.com\/services\/quality-assurance\/\" target=\"_blank\" rel=\"noreferrer noopener\">QA engineers<\/a> work with REST APIs, particularly useful in the case of more complex systems. A <b>ready-to-use Postman collection<\/b> is something that most developers will definitely appreciate, as it helps them save a lot of time and effort.<\/p>\n\n\n\n<div class=\"wp-block-image\"><figure class=\"aligncenter size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"601\" height=\"339\" src=\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/Salt-Edge-docs_postman.png\" alt=\"API DX Salt Edge Postman\" class=\"wp-image-11025\" srcset=\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/Salt-Edge-docs_postman.png 601w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/Salt-Edge-docs_postman-300x169.png 300w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/Salt-Edge-docs_postman-361x204.png 361w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/Salt-Edge-docs_postman-177x100.png 177w, https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/Salt-Edge-docs_postman-432x244.png 432w\" sizes=\"auto, (max-width: 601px) 100vw, 601px\" \/><figcaption><a href=\"https:\/\/codeandpepper.com\/case-studies\/the-id-co\/\" target=\"_blank\" rel=\"noreferrer noopener\">Salt Edge<\/a> API documentation. A feature called \u201c<a href=\"https:\/\/learning.postman.com\/docs\/publishing-your-api\/run-in-postman\/creating-run-button\/\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">Run in Postman<\/a>\u201d enables you to immediately load a collection of predefined requests: a huge time-saver!<\/figcaption><\/figure><\/div>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"h-integration-boost\">Integration boost<\/h3>\n\n\n\n<p>Integrating with an API shouldn\u2019t feel like climbing the walls. You can make the developers\u2019 lives a lot easier by providing <b>auto-generated Software Development Kits<\/b> <a href=\"https:\/\/github.com\/OpenAPITools\/openapi-generator\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">(SDKs)<\/a> for common programming languages or platforms. For JavaScript and TypeScript projects, you can use Node Package Manager and<b> publish SDKs as public npm packages<\/b>, so your client\u2019s developers can test your API in their CI\/CD pipelines. It makes the whole integration process much more robust and easy to maintain. Similar solutions are also available for other languages, e.g. NuGet package manager dedicated to <a href=\"https:\/\/codeandpepper.com\/services\/dot-net-developers\/\" target=\"_blank\" rel=\"noreferrer noopener\">.NET development<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-developer-experience-matters\">Developer Experience matters!<\/h2>\n\n\n\n<p>The API economy offers FinTech businesses countless options of connecting their products to boost them with financial data or processing power. However, the growing complexity of the digital landscape calls for shedding more light on <strong>Developer Experience in API development<\/strong>. Forget about developers and your API is in risk of never fulfilling its potential or worse: sinking into oblivion. Recognize and empower them instead &#8211; and the chances for world-wide adoption of your API-enabled solution might just skyrocket.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Forget about developers and your API is in risk of never fulfilling its potential or worse: sinking into oblivion. Recognize and empower them instead &#8211; and the chances for the world-wide adoption of your API-enabled solution might just skyrocket.<\/p>\n","protected":false},"author":8,"featured_media":10999,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"inline_featured_image":false,"footnotes":""},"categories":[1647],"tags":[1088,186,184],"class_list":["post-10953","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-software-development","tag-cross-platform-app-development","tag-fintech-developers","tag-technology-solutions"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v26.4 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>API Developer Experience: Tricks of the Trade | Code &amp; Pepper<\/title>\n<meta name=\"description\" content=\"If you want to build a future-proof and integration-ready API, don&#039;t forget about Developer Experience. Read the pro tips from Code &amp; Pepper.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/codeandpepper.com\/api-developer-experience\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API Developer Experience: Tricks of the Trade | Code &amp; Pepper\" \/>\n<meta property=\"og:description\" content=\"If you want to build a future-proof and integration-ready API, don&#039;t forget about Developer Experience. Read the pro tips from Code &amp; Pepper.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/codeandpepper.com\/api-developer-experience\/\" \/>\n<meta property=\"og:site_name\" content=\"Code &amp; Pepper\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/codeandpepper\/\" \/>\n<meta property=\"article:published_time\" content=\"2020-09-09T06:33:00+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-11-29T16:18:43+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"625\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Lucas Korol\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@codeandpepper\" \/>\n<meta name=\"twitter:site\" content=\"@codeandpepper\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Lucas Korol\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"6 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/\"},\"author\":{\"name\":\"Lucas Korol\",\"@id\":\"https:\/\/codeandpepper.com\/#\/schema\/person\/5b1864f35df18937cf175183e64ee7f5\"},\"headline\":\"API Developer Experience: Tricks of the Trade\",\"datePublished\":\"2020-09-09T06:33:00+00:00\",\"dateModified\":\"2020-11-29T16:18:43+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/\"},\"wordCount\":1192,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/codeandpepper.com\/#organization\"},\"image\":{\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png\",\"keywords\":[\"Cross-platform app development\",\"FinTech developers\",\"Technology solutions\"],\"articleSection\":[\"Software Development\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/codeandpepper.com\/api-developer-experience\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/\",\"url\":\"https:\/\/codeandpepper.com\/api-developer-experience\/\",\"name\":\"API Developer Experience: Tricks of the Trade | Code &amp; Pepper\",\"isPartOf\":{\"@id\":\"https:\/\/codeandpepper.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png\",\"datePublished\":\"2020-09-09T06:33:00+00:00\",\"dateModified\":\"2020-11-29T16:18:43+00:00\",\"description\":\"If you want to build a future-proof and integration-ready API, don't forget about Developer Experience. Read the pro tips from Code & Pepper.\",\"breadcrumb\":{\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/codeandpepper.com\/api-developer-experience\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/#primaryimage\",\"url\":\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png\",\"contentUrl\":\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png\",\"width\":1200,\"height\":625,\"caption\":\"DX in API development\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/codeandpepper.com\/api-developer-experience\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/codeandpepper.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Developer Experience: Tricks of the Trade\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/codeandpepper.com\/#website\",\"url\":\"https:\/\/codeandpepper.com\/\",\"name\":\"Code & Pepper\",\"description\":\"FinTech Developers\",\"publisher\":{\"@id\":\"https:\/\/codeandpepper.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/codeandpepper.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/codeandpepper.com\/#organization\",\"name\":\"Code & Pepper\",\"url\":\"https:\/\/codeandpepper.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/codeandpepper.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2019\/06\/logo.png\",\"contentUrl\":\"https:\/\/codeandpepper.com\/wp-content\/uploads\/2019\/06\/logo.png\",\"width\":319,\"height\":144,\"caption\":\"Code & Pepper\"},\"image\":{\"@id\":\"https:\/\/codeandpepper.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/codeandpepper\/\",\"https:\/\/x.com\/codeandpepper\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/codeandpepper.com\/#\/schema\/person\/5b1864f35df18937cf175183e64ee7f5\",\"name\":\"Lucas Korol\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/codeandpepper.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/d6e996443cf6e94fdec1e0edd93d9f5c2747ad69c62bf4f99f1e084f862ba6dd?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/d6e996443cf6e94fdec1e0edd93d9f5c2747ad69c62bf4f99f1e084f862ba6dd?s=96&d=mm&r=g\",\"caption\":\"Lucas Korol\"},\"description\":\"Head of Products &amp; Partner. He graduated from the Gdansk University of Technology with a master\u2019s degree in Electronics and Telecommunication. He started his software development business the day after leaving university. For more than ten years he has led more than a hundred projects. Right now, as the Head of Product Development in Code &amp; Pepper, he is shaping the way Code &amp; Pepper clients\u2019 products are build from start to end. He is passionate about all aspects of product development with a keen eye on requirements definition and product design.\",\"sameAs\":[\"https:\/\/www.linkedin.com\/in\/lukaszkorol\/\"],\"url\":\"https:\/\/codeandpepper.com\/author\/lucas-korol\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API Developer Experience: Tricks of the Trade | Code &amp; Pepper","description":"If you want to build a future-proof and integration-ready API, don't forget about Developer Experience. Read the pro tips from Code & Pepper.","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:\/\/codeandpepper.com\/api-developer-experience\/","og_locale":"en_US","og_type":"article","og_title":"API Developer Experience: Tricks of the Trade | Code &amp; Pepper","og_description":"If you want to build a future-proof and integration-ready API, don't forget about Developer Experience. Read the pro tips from Code & Pepper.","og_url":"https:\/\/codeandpepper.com\/api-developer-experience\/","og_site_name":"Code &amp; Pepper","article_publisher":"https:\/\/www.facebook.com\/codeandpepper\/","article_published_time":"2020-09-09T06:33:00+00:00","article_modified_time":"2020-11-29T16:18:43+00:00","og_image":[{"width":1200,"height":625,"url":"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png","type":"image\/png"}],"author":"Lucas Korol","twitter_card":"summary_large_image","twitter_creator":"@codeandpepper","twitter_site":"@codeandpepper","twitter_misc":{"Written by":"Lucas Korol","Est. reading time":"6 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/codeandpepper.com\/api-developer-experience\/#article","isPartOf":{"@id":"https:\/\/codeandpepper.com\/api-developer-experience\/"},"author":{"name":"Lucas Korol","@id":"https:\/\/codeandpepper.com\/#\/schema\/person\/5b1864f35df18937cf175183e64ee7f5"},"headline":"API Developer Experience: Tricks of the Trade","datePublished":"2020-09-09T06:33:00+00:00","dateModified":"2020-11-29T16:18:43+00:00","mainEntityOfPage":{"@id":"https:\/\/codeandpepper.com\/api-developer-experience\/"},"wordCount":1192,"commentCount":0,"publisher":{"@id":"https:\/\/codeandpepper.com\/#organization"},"image":{"@id":"https:\/\/codeandpepper.com\/api-developer-experience\/#primaryimage"},"thumbnailUrl":"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png","keywords":["Cross-platform app development","FinTech developers","Technology solutions"],"articleSection":["Software Development"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/codeandpepper.com\/api-developer-experience\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/codeandpepper.com\/api-developer-experience\/","url":"https:\/\/codeandpepper.com\/api-developer-experience\/","name":"API Developer Experience: Tricks of the Trade | Code &amp; Pepper","isPartOf":{"@id":"https:\/\/codeandpepper.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/codeandpepper.com\/api-developer-experience\/#primaryimage"},"image":{"@id":"https:\/\/codeandpepper.com\/api-developer-experience\/#primaryimage"},"thumbnailUrl":"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png","datePublished":"2020-09-09T06:33:00+00:00","dateModified":"2020-11-29T16:18:43+00:00","description":"If you want to build a future-proof and integration-ready API, don't forget about Developer Experience. Read the pro tips from Code & Pepper.","breadcrumb":{"@id":"https:\/\/codeandpepper.com\/api-developer-experience\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/codeandpepper.com\/api-developer-experience\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/codeandpepper.com\/api-developer-experience\/#primaryimage","url":"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png","contentUrl":"https:\/\/codeandpepper.com\/wp-content\/uploads\/2020\/08\/developer_experience.png","width":1200,"height":625,"caption":"DX in API development"},{"@type":"BreadcrumbList","@id":"https:\/\/codeandpepper.com\/api-developer-experience\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/codeandpepper.com\/"},{"@type":"ListItem","position":2,"name":"API Developer Experience: Tricks of the Trade"}]},{"@type":"WebSite","@id":"https:\/\/codeandpepper.com\/#website","url":"https:\/\/codeandpepper.com\/","name":"Code & Pepper","description":"FinTech Developers","publisher":{"@id":"https:\/\/codeandpepper.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/codeandpepper.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/codeandpepper.com\/#organization","name":"Code & Pepper","url":"https:\/\/codeandpepper.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/codeandpepper.com\/#\/schema\/logo\/image\/","url":"https:\/\/codeandpepper.com\/wp-content\/uploads\/2019\/06\/logo.png","contentUrl":"https:\/\/codeandpepper.com\/wp-content\/uploads\/2019\/06\/logo.png","width":319,"height":144,"caption":"Code & Pepper"},"image":{"@id":"https:\/\/codeandpepper.com\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/codeandpepper\/","https:\/\/x.com\/codeandpepper"]},{"@type":"Person","@id":"https:\/\/codeandpepper.com\/#\/schema\/person\/5b1864f35df18937cf175183e64ee7f5","name":"Lucas Korol","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/codeandpepper.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/d6e996443cf6e94fdec1e0edd93d9f5c2747ad69c62bf4f99f1e084f862ba6dd?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d6e996443cf6e94fdec1e0edd93d9f5c2747ad69c62bf4f99f1e084f862ba6dd?s=96&d=mm&r=g","caption":"Lucas Korol"},"description":"Head of Products &amp; Partner. He graduated from the Gdansk University of Technology with a master\u2019s degree in Electronics and Telecommunication. He started his software development business the day after leaving university. For more than ten years he has led more than a hundred projects. Right now, as the Head of Product Development in Code &amp; Pepper, he is shaping the way Code &amp; Pepper clients\u2019 products are build from start to end. He is passionate about all aspects of product development with a keen eye on requirements definition and product design.","sameAs":["https:\/\/www.linkedin.com\/in\/lukaszkorol\/"],"url":"https:\/\/codeandpepper.com\/author\/lucas-korol\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/posts\/10953","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/users\/8"}],"replies":[{"embeddable":true,"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/comments?post=10953"}],"version-history":[{"count":83,"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/posts\/10953\/revisions"}],"predecessor-version":[{"id":17544,"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/posts\/10953\/revisions\/17544"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/media\/10999"}],"wp:attachment":[{"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/media?parent=10953"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/categories?post=10953"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/codeandpepper.com\/wp-json\/wp\/v2\/tags?post=10953"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}