# API Documentation Published articles for API Documentation. This is one page of public article previews, not the complete archive. Follow Next page to continue. Summaries are not the original full articles. ## Appwrite 2.1 is now available for self-hosting DevFeed: [Appwrite 2.1 is now available for self-hosting]() Original publisher: [Read original article]() Author: Atharva Deosthale Published: 2026-09-14T00:00:00Z Content type: article Language: en Sources: [Appwrite Blog]() Topics: [Appwrite](), [Amazon S3](), [hosting](), [API](), [API keys](), [Command-line interface](), [SDKs](), [Compression](), [Encryption]() Tags: [api](), [api-documentation](), [aws](), [cli](), [compression](), [encryption](), [hosting](), [products](), [s3](), [self-hosting](), [sign-in]() ### AI overview Appwrite 2.1 is available for self-hosted deployments. It adds the S3-compatible Storage API and AutoGravity image previews, along with TikTok and Kakao sign-in and Appwrite Console fixes. The release uses the existing upgrade command and migration process from Appwrite 2.0. ### Source excerpt Appwrite 2.1 brings the S3 API and AutoGravity to self-hosted instances, adds TikTok and Kakao sign-in, and fixes for Appwrite Console. ## The thoroughness of Tom Johnson's free Documenting API's course on OpenAPI 3.0 and Swagger UI DevFeed: [The thoroughness of Tom Johnson's free Documenting API's course on OpenAPI 3.0 and Swagger UI]() Original publisher: [Read original article]() Author: T.J. Maher (noreply@blogger.com) Published: 2026-09-09T21:17:32Z Content type: article Language: en Sources: [T.J. Maher]() Topics: [OpenAPI Specification](), [Documentation](), [REST API](), [Swagger](), [Testing](), [Postman](), [JavaScript](), [JSON](), [Authentication](), [cURL](), [Chrome](), [Open Source]() Tags: [api](), [api-documentation](), [authentication](), [chrome](), [chrome-extension](), [curl](), [documentation](), [github](), [javascript](), [json](), [openapi](), [pdf](), [postman](), [rest-api](), [swagger](), [testing]() ### AI overview The article reviews Tom Johnson's free "Documenting APIs: A guide for technical writers and engineers" course. It describes the course's 17 chapters, practical API-learning exercises, coverage of REST APIs, OpenAPI, Swagger UI, testing and publishing API documentation, and a PDF edition exceeding 900 pages. ### Source excerpt While researching information for my job about the Swagger UI and how it can be used for testing, I came across this free course, called Documenting APIs: A guide for technical writers and engineers at https://idratherbewriting.com/learnapidoc/docapis_overview.html written by Tom Johnson, a technical writer based in Seattle who works for Google. The course looks intense, containing 17 chapters talking about Introduction to REST APIs, using APIs like a developer, Documenting API endpoints, the Open API spec, Testing API docs, Publishing API docs, and more. From the Course Introduction: "You'll first learn about API documentation by using a simple weather API to put a weather forecast on your site. [...] As you use the API, you'll learn about endpoints, parameters, data types, authentication, curl, JSON, the command line, Chrome's Developer Console, JavaScript, and more. The idea is that rather than learning about these concepts independent of any context, you learn them by immersing yourself in a real scenario while using an API. Immersion in real scenarios makes these tools and technologies more meaningful. "We'll then transition into standards, tools, and specifications for REST APIs. You'll learn about the required sections in API documentation, analyze examples of REST API documentation from various companies, learn how to join an open-source project to get experience, and more. "[...] We'll also dive into specifications such as the OpenAPI specification and Swagger UI (which provides tooling for the OpenAPI specification). Additionally, you'll learn how to document native library APIs and generate Javadoc". Tom Johnson offers a PDF version of this free course... over 900 pages, with more always being added. It also offers many workshop-like activities you could put in an actual itinerary. You would need for the course: Chrome, since it provides "a Javascript Console that works well for inspecting JSON", the JSON Formatter Chrome extension, Postman, a GitHub acco ## How to Document Error Messages and Error Codes for Users and AI Agents DevFeed: [How to Document Error Messages and Error Codes for Users and AI Agents]() Original publisher: [Read original article]() Author: Selvaraaju Murugesan Published: 2026-09-08T12:41:27Z Content type: tutorial Language: en Sources: [Knowledge Management Tips, Best Practices and More]() Topics: [AI Agent](), [Documentation](), [API](), [Development]() Tags: [ai](), [ai-agent](), [api-documentation](), [documentation](), [error-messages](), [how-to]() ### AI overview This tutorial explains how to document error messages and error codes for users and AI agents. It recommends actionable messages that identify causes and next steps, distinguishes messages from stable error codes and documentation pages, and gives an API-key permission example. ### Source excerpt Error messages often frustrate users and AI agents. A good error message helps ... The post How to Document Error Messages and Error Codes for Users and AI Agents appeared first on Document360. ## Testing the Swagger Petstore: Reviewing API Documentation Formatted in OpenAPI 3.0 with Swagger UI DevFeed: [Testing the Swagger Petstore: Reviewing API Documentation Formatted in OpenAPI 3.0 with Swagger UI]() Original publisher: [Read original article]() Author: T.J. Maher (noreply@blogger.com) Published: 2026-09-05T03:09:27Z Content type: article Language: en Sources: [T.J. Maher]() Topics: [OpenAPI Specification](), [Swagger](), [API](), [Documentation](), [Testing]() Tags: [api](), [api-documentation](), [openapi](), [swagger](), [testing]() ### AI overview This article reviews the Swagger Petstore test site and its API documentation formatted with OpenAPI 3.0 and Swagger UI. It also provides background on Swagger's origins, its acquisition by SmartBear, and the distinction between the OpenAPI Specification and SmartBear's Swagger toolset. ### Source excerpt For this next project, we will be examining the test site Swagger Petstore - OpenAPI 3.0 at https://petstore3.swagger.io/ https://petstore3.swagger.io/ If we wanted to really dive deep into creating API documentation, we could use: I'dRatherBeWriting's Free Documenting APIs course, showing an Introduction to REST APIs, using APIs like a developer, Documenting API endpoints, the Open API spec, Testing API docs, Publishing API docs, and more... ... But that goes too deep for this blog post. Before we begin, let's get into some background information. What is Swagger? According to OpenAPISpec.com's article, Who Created Swagger?, Swagger was created in 2010 by Tony Tam, the CTO of Wordnik, an online dictionary company that leveraged so many APIs, it was difficult for the six person engineering team to manage and scale them, writing API-clients and documentation by hand. After a 3 AM conversation, they thought... what if the API documentation could describe itself? There already was WADL, the XML-based Web Application Description Language. The name was coined after a joke they made, "Why WADL when you can Swagger?" Swagger went from being an internal fix for a company became to an open-source project other companies relied on. Swagger was acquired by SmartBear Software in 2015 from the renamed Wordnik, Reverb Technologies. According to OpenAPISpec's What Is the History of the SmartBear Swagger Acquisition Tony Tam also joined SmartBear as the VP of Products. Smartbear donated the Swagger Specification to a new group, the OpenAPI Initiative, sponsored by the Linux Foundation. I love SmartBear! They have hosted my old software testing Meetup, the now defunct Ministry of Testing - Boston many, many times. Since then: "OpenAPI" is the OpenAPI Specification as seen on GitHub "Swagger" is SmartBear's toolset such as Swagger UI, Swagger Editor, Swagger Codegen, and SwaggerHub (soon to be Swagger Studio). OpenAPI Initiative: Bridging Systems and Subcultures: A Swagger Origin Sto ## 10 Tips for Preparing APIs for Agentic Access DevFeed: [10 Tips for Preparing APIs for Agentic Access]() Original publisher: [Read original article]() Author: J Simpson Published: 2026-08-27T11:40:00Z Content type: article Language: en Sources: [Nordic APIs]() Topics: [Artificial Intelligence](), [observability](), [Security](), [Architecture & Design](), [Cloudflare]() Tags: [agentic](), [agentic-ai](), [ai](), [ai-agents](), [api-best-practices](), [api-design](), [api-discovery](), [api-documentation](), [api-monitoring](), [api-security](), [apis](), [artificial-intelligence](), [blog](), [json-schema](), [oauth](), [observability](), [openapi-specification](), [security](), [workflows]() ### AI overview Ten ways to prepare APIs for agentic access by improving discovery, security, observability, workflows, and predictable design for AI agents. ### Source excerpt In May 2026, Cloudflare released a new tool called isitagentready.com. It analyzes a URL for everything an agentic AI would need to interact with a site and then returns a score out of 100. Even better still, it breaks down its assessment by category, letting you know how your site performs for discoverability, accessibility from ... ## Keeping Documentation Honest with an OpenAPI Snapshot Diff DevFeed: [Keeping Documentation Honest with an OpenAPI Snapshot Diff]() Original publisher: [Read original article]() Author: Philipp Lehmann (philipp.lehmann@gruppe.ai) Published: 2026-08-25T07:00:00Z Content type: tutorial Language: en Sources: [Philipp Lehmann]() Topics: [OpenAPI Specification](), [FastAPI](), [ci](), [Pytest](), [Documentation](), [JSON](), [test]() Tags: [api-documentation](), [ci](), [ci-cd](), [documentation](), [fastapi](), [json](), [openapi](), [pytest](), [test](), [testing]() ### AI overview The article explains how to keep API documentation aligned with a FastAPI application by generating its OpenAPI schema from the running code, comparing it with a committed snapshot in CI, normalizing the JSON diff, and requiring deliberate snapshot regeneration. ### Source excerpt FastAPI app.openapi() snapshot test in pytest: fail CI when the live OpenAPI schema drifts from the committed openapi.snapshot.json. ## API Gateways, AI Gateways, and MCP Gateways: Are Enterprises About to Pay Twice Again? DevFeed: [API Gateways, AI Gateways, and MCP Gateways: Are Enterprises About to Pay Twice Again?]() Original publisher: [Read original article]() Author: Rashmi Baberwal Published: 2026-08-12T07:00:00Z Content type: article Language: en Sources: [Nordic APIs]() Topics: [API](), [Model Context Protocol](), [Artificial Intelligence](), [Security](), [observability]() Tags: [ai](), [ai-agents](), [api](), [api-architecture](), [api-discovery](), [api-documentation](), [api-gateway](), [api-governance](), [api-management](), [api-monitoring](), [apis](), [artificial-intelligence](), [blog](), [generative-ai](), [infrastructure](), [mcp](), [observability](), [platforms](), [security](), [strategy]() ### AI overview The article examines how enterprises can prepare existing API infrastructure for AI gateways, MCP gateways, and agent-driven operations. It highlights prior investments in API management platforms, gateways, developer portals, security, observability, and API-first development. ### Source excerpt Over the last decade, enterprises invested heavily in API infrastructure. They purchased API management platforms, deployed gateways across business units and regions, built developer portals, introduced security and observability tools, and encouraged teams to adopt API-first development. The business case was compelling. APIs would make enterprise capabilities easier to reuse, shorten integration timelines, improve partner ... ## Introducing Document360's New API Documentation Experience DevFeed: [Introducing Document360's New API Documentation Experience]() Original publisher: [Read original article]() Author: Darshan Sureshkumar Published: 2026-08-07T13:29:10Z Content type: release Language: en Sources: [Knowledge Management Tips, Best Practices and More]() Topics: [API](), [Documentation](), [console](), [Authentication](), [ChatGPT](), [Claude]() Tags: [api](), [api-documentation](), [authentication](), [chatgpt](), [claude](), [console](), [developers](), [documentation](), [interactive](), [product-update](), [release](), [update]() ### AI overview Document360 introduces a redesigned API Reference with a three-pane layout, an interactive Try It! Console, reusable session variables, in-console authentication, and endpoint questions through Eddy AI. The release also expands Global Find & Replace across reusable content and knowledge base elements, and adds documentation-to-ChatGPT or Claude workflows. ### Source excerpt Developers expect API references they can experiment with instantly. Documentation teams need faster ... The post Introducing Document360's New API Documentation Experience appeared first on Document360. ## Learning Path: FastAPI: Python API Development With Light Speed DevFeed: [Learning Path: FastAPI: Python API Development With Light Speed]() Original publisher: [Read original article]() Author: Real Python Published: 2026-07-22T12:00:00Z Content type: tutorial Language: en Sources: [Real Python]() Topics: [FastAPI](), [Python](), [API](), [REST API](), [Pydantic](), [Web Development](), [CRUD]() Tags: [api](), [api-documentation](), [database](), [development](), [python](), [rest](), [tutorial](), [validation](), [web-development]() ### AI overview This learning path teaches Python developers how to build REST APIs and complete web applications with FastAPI. It covers automatic validation, serialization, interactive documentation, Pydantic data models, CRUD operations, Jinja2-rendered web pages, and a URL shortener project. ### Source excerpt Learn FastAPI from the ground up. Build REST APIs, serve web pages with Jinja2 templates, and create a complete URL shortener project in Python. ## The skills.sh API is now available DevFeed: [The skills.sh API is now available]() Original publisher: [Read original article]() Author: Andrew Qu Published: 2026-06-05T00:00:00Z Content type: release Language: en Sources: [Vercel News]() Topics: [API](), [Vercel](), [OpenID connect (OIDC)](), [Security](), [Open Source]() Tags: [api](), [api-documentation](), [documentation](), [oidc](), [open-source](), [security](), [skills](), [vercel]() ### AI overview Vercel has released the skills.sh API, enabling authenticated access to more than 600,000 open-source skills. The API supports skill search, detailed information retrieval, and security-audit checks. ### Source excerpt The skills.sh API is now available. Authenticate with your project's Vercel OIDC token and start querying more than 600,000 skills from across the open-source ecosystem. Search for skills, pull detailed info on any one, check its security audit, and more. Vercel issues a short-lived token scoped to your team and project, rotated automatically, so there's no long-lived secret to leak or rotate. On each request, skills.sh verifies the token and applies a rate limit of 600 requests per minute per team and project. Read the skills.sh API documentation to get started. Read more ## Mintlify Adds Flexible Documentation Publishing and Content Management Features DevFeed: [Mintlify Adds Flexible Documentation Publishing and Content Management Features]() Original publisher: [Read original article]() Author: Hahnbee Lee Published: 2026-02-18T00:00:00Z Content type: release Language: en Sources: [Mintlify Blog]() Topics: [Documentation](), [Publishing](), [Markdown](), [MDX](), [OpenAPI Specification](), [configuration]() Tags: [api-documentation](), [best-practices](), [customizable](), [documentation](), [flexible](), [markdown](), [mdx](), [new-features]() ### AI overview Mintlify describes new features for technical writers, including granular publishing controls, plain Markdown files alongside MDX, more flexible OpenAPI references, relative imports, and implicit snippets. ### Source excerpt New features for technical writers who need customizable, flexible documentation systems. ## Moving from Django DRF to Ninja API / Pydantic DevFeed: [Moving from Django DRF to Ninja API / Pydantic]() Original publisher: [Read original article]() Author: Michael Sidharta Published: 2025-11-10T05:35:43Z Content type: comparison Language: en Sources: [Kogan.com]() Topics: [Django](), [Pydantic](), [API](), [Python](), [Development](), [OpenAPI Specification](), [Swagger]() Tags: [api-documentation](), [data-validation](), [django](), [fastapi](), [python](), [swagger]() ### AI overview This article examines moving from Django REST Framework API patterns to Django Ninja API and Pydantic. It describes motivations including reducing boilerplate, improving performance for some use cases, using modern Python type hints and data validation, and enhancing developer experience. It also outlines Django Ninja's type-based validation, automatic OpenAPI documentation, performance focus, and simplified endpoint definitions. ### Source excerpt As our project grows, we're always looking for ways to streamline development, improve performance, and enhance the developer experience. Recently, we've been exploring a shift from our traditional Django REST Framework (DRF) API patterns to a combination of Django Ninja API and Pydantic. This blog post will delve into our motivations for this change, the benefits we've observed, and some considerations for others contemplating a similar transition. Why Consider a Change from Django DRF? Django REST Framework has been a robust and widely adopted solution for building APIs with Django. It provides a comprehensive set of tools, including serializers, viewsets, and excellent browser-based API interfaces. However, as our needs evolved, we identified areas where a different approach could offer advantages: Boilerplate Code: While DRF offers powerful abstractions, creating serializers, views, and viewsets can sometimes lead to a significant amount of boilerplate code, especially for simpler APIs. Performance: For certain use cases, the overhead of DRF's serializer validation and rendering can impact performance, particularly in high-throughput scenarios. Modern Python Features: We were keen to leverage modern Python features like type hints and data validation more extensively, which are core to Pydantic. Developer Experience: A more concise and explicit way to define API endpoints and data structures could improve developer productivity and reduce potential errors. Introducing Django Ninja API and PydanticDjango Ninja API Django Ninja is a web framework for building APIs with Django and Python 3.6+ type hints. It's heavily inspired by FastAPI and offers a number of compelling features: Type Hinting for API Endpoints: You define your request and response models using Pydantic, and Ninja automatically validates and serializes the data based on these type hints. Automatic OpenAPI (Swagger) Documentation: Just like FastAPI, Ninja generates interactive API documentation out o ## Structured Tags in OpenAPI 3.2: Organising APIs the Way They Deserve DevFeed: [Structured Tags in OpenAPI 3.2: Organising APIs the Way They Deserve]() Original publisher: [Read original article]() Author: Zaid Daba'een Published: 2025-10-26T21:00:37Z Content type: article Language: en Sources: [DeveloperHub.io]() Topics: [OpenAPI Specification](), [Documentation](), [API](), [SDKs]() Tags: [api-design](), [api-documentation](), [engineering](), [modular](), [navigation](), [openapi](), [sdks](), [structured]() ### AI overview OpenAPI 3.2 adds structured, hierarchical tags that let APIs organize endpoints into nested categories. The article explains how this can improve documentation navigation, SDK organization, and maintainability for large or modular APIs. ### Source excerpt OpenAPI 3.2 introduces structured tags, allowing APIs to organize endpoints into nested categories for clearer, more maintainable documentation. ## The /api Namespace is Now Open DevFeed: [The /api Namespace is Now Open]() Original publisher: [Read original article]() Author: Nick Khami Published: 2025-10-06T00:00:00Z Content type: release Language: en Sources: [Mintlify Blog]() Topics: [API](), [Documentation]() Tags: [api](), [api-documentation](), [article](), [product-updates](), [update]() ### AI overview Mintlify now allows documentation pages at the /api path, enabling cleaner URLs that align with API structures. The change follows Mintlify's migration from NextJS Pages Router to App Router, where API endpoints and rendered pages can coexist in the same namespace. ### Source excerpt Mintlify now supports documentation pages at the /api path, enabling cleaner URLs that match your API structure. ## Should you generate docs from your API schema? DevFeed: [Should you generate docs from your API schema?]() Original publisher: [Read original article]() Author: Emma Adler Published: 2025-05-16T00:00:00Z Content type: tutorial Language: en Sources: [Mintlify Blog]() Topics: [Documentation](), [OpenAPI Specification](), [API](), [Structured-data](), [Swagger](), [JSON](), [YAML]() Tags: [ai-trends](), [api](), [api-documentation](), [automate](), [automation](), [best-practices](), [hybrid](), [json](), [openapi](), [schemas](), [swagger]() ### AI overview This guide examines the benefits and limitations of generating API documentation from OpenAPI schemas. It explains how schema-based tools such as Swagger UI automatically create documentation from structured endpoint, method, data model, and response definitions, while noting that automation can leave gaps in user guidance and conceptual explanations. It recommends combining automation with customization. ### Source excerpt When your API constantly changes, how do you ensure your documentation keeps up? ## Should you build or buy an API documentation tool? DevFeed: [Should you build or buy an API documentation tool?]() Original publisher: [Read original article]() Author: Tiffany Chen Published: 2025-02-26T00:00:00Z Content type: tutorial Language: en Sources: [Mintlify Blog]() Topics: [API](), [Documentation](), [Developer experience](), [Tool]() Tags: [api](), [api-documentation](), [article](), [best-practices](), [developer-experience](), [technical]() ### AI overview A guide for engineering teams deciding whether to build or buy an API documentation tool. It compares customization, engineering bandwidth, maintenance, infrastructure control, and developer experience, drawing on experiences from engineering leaders at Turso, Sierra, and Stytch. ### Source excerpt For companies that rely on a strong developer experience, technical documentation is more than just a helpful resource--it is a key differentiator. ## Why New Developers Avoid Documentation and How to Improve Onboarding Docs DevFeed: [Why New Developers Avoid Documentation and How to Improve Onboarding Docs]() Original publisher: [Read original article]() Author: Emma Adler Published: 2025-02-12T00:00:00Z Content type: article Language: en Sources: [Mintlify Blog]() Topics: [Documentation](), [coding](), [API]() Tags: [ai-trends](), [api-documentation](), [documentation](), [guide](), [how-to](), [onboarding]() ### AI overview This article argues that new developers often abandon documentation because it is poorly designed, incomplete, outdated, or disconnected from their workflows. It recommends quick starts, real-world examples, and living documentation to improve onboarding. ### Source excerpt It's common to hear that developers skip documentation, but the reality is more complex. This assumption oversimplifies the issue and can lead to documentation practices within the team that make onboarding harder for new hires. ## What makes good API documentation? Best tools and examples DevFeed: [What makes good API documentation? Best tools and examples]() Original publisher: [Read original article]() Author: Emma Adler Published: 2025-01-01T00:00:00Z Content type: comparison Language: en Sources: [Mintlify Blog]() Topics: [Documentation](), [API](), [Artificial Intelligence](), [AI-assisted coding]() Tags: [ai-trends](), [api](), [api-documentation](), [article](), [docs-as-code](), [generative-ai](), [guide]() ### AI overview A comparison of API documentation tools, including Mintlify, ReadMe, GitBook, SwaggerHub, Stoplight, Postman, Docusaurus, and Redocly. It evaluates docs-as-code workflows, AI readiness, interactive API explorers, collaboration, and pricing, with recommendations for different team needs. ### Source excerpt The API documentation software landscape is evolving fast in 2025. With AI advancements and rising developer expectations, companies must elevate their developer documentation to stay competitive. ## How to Write Code Comments That Improve Readability DevFeed: [How to Write Code Comments That Improve Readability]() Original publisher: [Read original article]() Author: Google Testing Bloggers (noreply@blogger.com) Published: 2023-12-12T16:06:00Z Content type: tutorial Language: en Sources: [Google Testing Blog]() Topics: [Code](), [Documentation](), [implementation]() Tags: [api-documentation](), [code](), [code-health](), [documentation](), [francois-aube](), [guide](), [readability](), [shiva-garg](), [tott]() ### AI overview The article offers practical guidance for writing maintainable code: use comments to explain why an approach is taken, choose descriptive identifiers, document function purpose and meaning, and avoid comments about implementation details that may change. ### Source excerpt This is another post in our Code Health series. A version of this post originally appeared in Google bathrooms worldwide as a Google Testing on the Toilet episode. You can download a printer-friendly version to display in your office. by Shiva Garg and Francois Aube Comments can be invaluable for understanding and maintaining a code base. But excessive comments in code can become unhelpful clutter full of extraneous and/or outdated detail. Comments that offer useless (or worse, obsolete) information hurt readability. Here are some tips to let your code speak for itself: Write comments to explain the "why" behind a certain approach in code. The comment below has two good reasons to exist: documenting non-obvious behavior and answering a question that a reader is likely to have (i.e. why doesn't this code render directly on the screen?): // Eliminate flickering by rendering the next frame off-screen and swapping into the // visible buffer. RenderOffScreen(); SwapBuffers(); Use well-named identifiers to guide the reader and reduce the need for comments: // Payout should not happen if the user is // in an ineligible country. std::unordered_set ineligible = {"Atlantis", "Utopia"}; if (!ineligible.contains(country)) { Payout(user.user_id); } if (IsCountryEligibleForPayout(country)) { Payout(user.user_id); } Write function comments (a.k.a. API documentation) that describe intended meaning and purpose, not implementation details. Choose unambiguous function signatures that callers can use without reading any documentation. Don't explain inner details that could change without affecting the contract with the caller: // Reads an input string containing either a // number of milliseconds since epoch or an // ISO 8601 date and time. Invokes the // Sole, Laces, and ToeCap APIs, then // returns an object representing the Shoe // available then or nullptr if none were. Shoe* ModelAvailableAt(char* time); // Returns the Shoe that was available for // purchase at `time` ## A brief introduction to OpenAPI DevFeed: [A brief introduction to OpenAPI]() Original publisher: [Read original article]() Author: HTTP Toolkit; Phil Sturgeon Published: 2023-11-28T09:30:00Z Content type: tutorial Language: en Sources: [HTTP Toolkit]() Topics: [OpenAPI Specification](), [API](), [HTTP](), [JSON Schema](), [Documentation](), [JSON](), [SDKs](), [Testing]() Tags: [api](), [api-documentation](), [apis](), [graphql](), [http](), [json-schema](), [openapi](), [sdks](), [standards](), [swagger](), [validation]() ### AI overview An introduction to OpenAPI as a machine-readable description format for HTTP APIs. The article explains how OpenAPI describes endpoints, requests, responses, authentication, and validation, and how it supports documentation, testing, validation, SDK generation, server stubs, and mock servers. ### Source excerpt It's hard to work on APIs without hearing about OpenAPI. OpenAPI is an API description format, which is essentially metadata that describes an HTTP API: where it lives, how it works, what data is available, and how it's authenticated. Additional keywords can be used to provide all sorts of validation information, adding a type system to what would otherwise just be arbitrary JSON flying around the internet. OpenAPI has been around for donkeys years, previously known as Swagger but renamed to OpenAPI in 2016. It's powered by JSON Schema, which is also pretty popular in certain circles, but it's only in the last few years that OpenAPI has solidified its place as the description format for HTTP APIs, pushing aside others like RAML and API Blueprint. Elder developers will remember working with WSDLs and XML Schema, and gRPC and GraphQL folks might be thinking "hang on this sounds a bit familiar", and absolutely. Type systems for APIs are pretty common, but here's an excellent one you can use for your REST/RESTish API. Here's an example to give you an idea: openapi: 3.1.3 info: title: Your Awesome API version: '1.0.3' description: More information and introduction. paths: /things: post: summary: Create a thing requestBody: content: application/json: schema: type: object properties: name: type: string examples: - Tim responses: '201': description: "Created" content: application/json: schema: type: object properties: id: type: string format: uuid name: type: string examples: - Tim created_at: type: string format: date-time example: 2020-01-01T00:00:00Z This describes an API in a machine-readable format, including overall metadata, endpoint paths, request formats, and the details of possible responses you might receive. What can OpenAPI do? OpenAPI specifications provide a machine-readable base on top of which lots of neat API tools can be used and even generated. One of the most common uses by many API teams to to generate API reference documentation, which helps end-users ## Autogenerating API documentation from OpenAPI DevFeed: [Autogenerating API documentation from OpenAPI]() Original publisher: [Read original article]() Author: Hahnbee Lee Published: 2023-09-15T00:00:00Z Content type: tutorial Language: en Sources: [Mintlify Blog]() Topics: [API](), [OpenAPI Specification](), [Tutorial](), [Documentation](), [JSON](), [YAML]() Tags: [api](), [api-documentation](), [best-practices](), [deployment](), [documentation](), [github](), [json](), [openapi](), [swagger](), [tutorial](), [yaml]() ### AI overview A step-by-step tutorial showing how to generate API documentation from OpenAPI specifications using Mintlify. It covers preparing and validating an OpenAPI 3.0+ specification, configuring documentation, setting up deployment, generating endpoint MDX files, and organizing the resulting API documentation. ### Source excerpt If you're using OpenAPI and looking for a quick and efficient method to create beautiful API documentation, you're in the right place. ## Protocol: A beautiful starting point for your next API documentation site DevFeed: [Protocol: A beautiful starting point for your next API documentation site]() Original publisher: [Read original article]() Published: 2022-12-15T15:00:00Z Content type: release Language: en Sources: [Tailwind CSS Blog]() Topics: [Template](), [API](), [Documentation](), [MDX](), [Next.js](), [Tailwind CSS](), [React](), [Framer Motion](), [Library]() Tags: [api](), [api-documentation](), [building](), [code](), [components](), [documentation](), [js](), [markdown](), [mdx](), [next-js](), [react](), [tailwind-css]() ### AI overview Tailwind CSS introduces Protocol, a website template for building API reference documentation sites with Next.js and MDX. The article highlights its polished navigation and interaction design, authoring workflow, reusable components, and the mdx-annotations library for passing data through MDX tags. ### Source excerpt It's been months in the making but I'm excited to finally release our next website template -- Protocol, a beautiful starter kit for building amazing API reference websites. ## What's new in Figma: June 2022 DevFeed: [What's new in Figma: June 2022]() Original publisher: [Read original article]() Author: Andrew Forbes Published: 2022-06-28T00:00:00Z Content type: article Language: en Sources: [Figma Blog]() Topics: [Figma](), [Extension](), [API](), [Automation]() Tags: [api](), [api-documentation](), [automation](), [code](), [extensions](), [figma](), [latest-features](), [plugins]() ### AI overview This June 2022 roundup presents new Figma and FigJam features focused on extensibility, collaboration, and discoverability. It introduces interactive widgets for collaborative workflows, highlights integrations such as Asana and Jira, adds toolbar search and installation for plugins and widgets, and describes redesigned API documentation with improved navigation, resource organization, copyable code blocks, samples, and guides. ### Source excerpt A monthly round-up of the latest features, fixes, and finesse we've added to Figma and FigJam. ## How to embed Explorer for a private graph DevFeed: [How to embed Explorer for a private graph]() Original publisher: [Read original article]() Author: Maya Koneval Published: 2022-06-09T09:24:00Z Content type: tutorial Language: en Sources: [Apollo Blog]() Topics: [GraphQL](), [Documentation](), [API](), [configuration](), [ide]() Tags: [api](), [api-documentation](), [code](), [configuration](), [embedded](), [environment-variables](), [graphql](), [how-to](), [tooling]() ### AI overview A tutorial explaining how to embed Apollo Explorer for a private GraphQL graph in a developer portal or documentation site. It covers prerequisites and embed configuration options such as theme, panel state, headers, and environment variables. ### Source excerpt Strong documentation is an essential best practice for any GraphQL API. One of the best parts of GraphQL is that it's self-documenting, but nearly every engineering organization has additional internal documentation sites and dev portals designed to provide developers additional context and make them more successful. To prevent context switching, GraphQL API documentation is often embedded into these other resources using tools like GraphQL Playground or GraphiQL. [Next page]()