Create README.md

README.md

@@ -0,0 +1,272 @@
+# Awesome API Documentation Tools
+
+![Awesome](https://awesome.re/badge.svg)
+
+> A curated list of awesome API documentation tools and resources to help you build, maintain, and share better API documentation.
+
+API documentation tools help developers create, maintain, and publish documentation for their APIs. This comprehensive list includes a wide variety of tools to suit different needs, workflows, and programming languages.
+
+## Contents
+
+- [Complete Platforms](#complete-platforms)
+- [Open Source Tools](#open-source-tools)
+- [Documentation Generators](#documentation-generators)
+- [Specification Tools](#specification-tools)
+- [Language-Specific Tools](#language-specific-tools)
+- [Visual Documentation Tools](#visual-documentation-tools)
+- [Documentation Hosting](#documentation-hosting)
+- [API Testing with Doc Features](#api-testing-with-doc-features)
+- [IDE Extensions & Plugins](#ide-extensions--plugins)
+- [Markdown Tools](#markdown-tools)
+- [Static Site Generators for Docs](#static-site-generators-for-docs)
+- [API Design Tools](#api-design-tools)
+- [API Monitoring Tools](#api-monitoring-tools)
+- [Mock Servers](#mock-servers)
+- [API Gateways with Doc Features](#api-gateways-with-doc-features)
+- [Documentation Templates](#documentation-templates)
+- [AI-Powered Documentation Tools](#ai-powered-documentation-tools)
+- [Resources](#resources)
+- [Contributing](#contributing)
+
+## Complete Platforms
+
+*Full-featured platforms for API design, testing, and documentation.*
+
+1. [Apidog](https://apidog.com/) - An integrated platform for API design, debugging, testing, documentation, and mocking. Offers collaborative features specifically tailored for API development teams.
+[![](https://assets.apidog.com/static/www/assets/images/index/feature-api-doc-1.webp)](https://apidog.com)
+2. [Postman](https://www.postman.com/) - API platform for building and using APIs with features for request building, automated testing, and documentation generation.
+2. [SwaggerHub](https://swagger.io/tools/swaggerhub/) - Collaborative platform for API design and documentation built around the OpenAPI Specification.
+4. [Stoplight](https://stoplight.io/) - A design-first API platform with visual modeling, documentation, and testing tools.
+5. [Insomnia](https://insomnia.rest/) - Open-source API client with design, testing, and documentation capabilities.
+6. [ReadMe](https://readme.com/) - Personalized and interactive API documentation platform with analytics.
+7. [Apiary](https://apiary.io/) - API design and documentation platform with mock server capabilities.
+8. [RapidAPI](https://rapidapi.com/) - API marketplace with documentation features for API providers.
+9. [Mockoon](https://mockoon.com/) - API mocking and documentation tool for developers.
+10. [Hoppscotch](https://hoppscotch.io/) - Open source API development ecosystem with documentation features.
+
+## Open Source Tools
+
+*Free and open-source tools for API documentation.*
+
+11. [Swagger UI](https://swagger.io/tools/swagger-ui/) - Interactive API documentation generator that visualizes OpenAPI specifications.
+12. [ReDoc](https://github.com/Redocly/redoc) - OpenAPI/Swagger documentation generator creating responsive, three-panel documentation.
+13. [Slate](https://github.com/slatedocs/slate) - Beautiful static API documentation based on Markdown.
+14. [DapperDox](https://github.com/DapperDox/dapperdox) - Documentation generator for OpenAPI specifications.
+15. [Docbox](https://github.com/tmcw/docbox) - REST API documentation system built with React.
+16. [LucyBot](https://github.com/LucyBot-Inc/documentation-website) - Generate API documentation websites from OpenAPI specifications.
+17. [widdershins](https://github.com/Mermade/widdershins) - OpenAPI/Swagger/AsyncAPI definition to Markdown/Slate/HTML documentation.
+18. [Spectaql](https://github.com/anvilco/spectaql) - Documentation generator for GraphQL APIs.
+19. [DevDocs](https://github.com/freeCodeCamp/devdocs) - Open-source API documentation browser.
+20. [APITree](https://github.com/apicartin/apitree) - An open-source tool for visualizing and documenting APIs.
+
+## Documentation Generators
+
+*Tools that automatically generate documentation from code or specifications.*
+
+21. [Redocly](https://redocly.com/) - Tools for creating, managing, and publishing API documentation built on OpenAPI.
+22. [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) - Generate documentation and client libraries from OpenAPI specifications.
+23. [ApiDoc](https://apidocjs.com/) - Documentation generator from API annotations in source code.
+24. [Spring REST Docs](https://spring.io/projects/spring-restdocs) - Documentation generator for RESTful services that combines hand-written and auto-generated documentation.
+25. [JSDoc](https://jsdoc.app/) - API documentation generator for JavaScript.
+26. [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) - Generate documentation and client libraries from Swagger definitions.
+27. [Docusaurus](https://docusaurus.io/) - React-based static site generator optimized for documentation websites.
+28. [Javadoc](https://www.oracle.com/java/technologies/javase/javadoc-tool.html) - Documentation generator for Java APIs.
+29. [TypeDoc](https://typedoc.org/) - Documentation generator for TypeScript projects.
+30. [NSwag](https://github.com/RicoSuter/NSwag) - Swagger/OpenAPI toolchain for .NET with documentation generation capabilities.
+31. [drf-yasg](https://github.com/axnsan12/drf-yasg) - Automated generation of Swagger/OpenAPI documentation for Django REST Framework APIs.
+32. [GraphDoc](https://github.com/2fd/graphdoc) - Static page generator for GraphQL schema documentation.
+33. [Doctave](https://github.com/Doctave/doctave) - Documentation site generator with a focus on API documentation.
+34. [Raml2Html](https://github.com/raml2html/raml2html) - RAML to HTML documentation generator.
+35. [Doxygen](https://www.doxygen.nl/) - Documentation generator for multiple programming languages.
+
+## Specification Tools
+
+*Tools focused on API specifications and standards.*
+
+36. [OpenAPI (Swagger) Specification](https://github.com/OAI/OpenAPI-Specification) - The standard for describing RESTful APIs.
+37. [API Blueprint](https://apiblueprint.org/) - A documentation-oriented API description language.
+38. [RAML](https://raml.org/) - RESTful API Modeling Language for designing RESTful APIs.
+39. [JSON Schema](https://json-schema.org/) - Vocabulary that allows validation of JSON documents.
+40. [GraphQL](https://graphql.org/) - Query language and runtime for APIs that provides a complete description of the data available.
+41. [WSDL](https://www.w3.org/TR/wsdl/) - XML-based interface description language for SOAP services.
+42. [gRPC](https://grpc.io/) - High-performance RPC framework with built-in documentation via Protocol Buffers.
+43. [AsyncAPI](https://www.asyncapi.com/) - Specification for event-driven APIs.
+44. [HAL](https://stateless.group/hal_specification.html) - Hypermedia Application Language for building hypermedia-driven APIs.
+45. [OpenRPC](https://open-rpc.org/) - Specification for JSON-RPC 2.0 APIs.
+
+## Language-Specific Tools
+
+*Documentation tools specific to programming languages.*
+
+46. [Godoc](https://pkg.go.dev/golang.org/x/tools/cmd/godoc) - Documentation generator for Go projects.
+47. [Rustdoc](https://doc.rust-lang.org/rustdoc/) - Documentation generator for Rust projects.
+48. [PHPDoc](https://www.phpdoc.org/) - Documentation generator for PHP projects.
+49. [pydoc](https://docs.python.org/3/library/pydoc.html) - Documentation generator for Python.
+50. [Sphinx](https://www.sphinx-doc.org/) - Python documentation generator with API doc support.
+51. [Yard](https://yardoc.org/) - Documentation generator for Ruby.
+52. [Sandcastle](https://github.com/EWSoftware/SHFB) - Documentation compiler for .NET projects.
+53. [ESDoc](https://esdoc.org/) - API documentation generator for JavaScript.
+54. [Swiftdoc](https://github.com/SwiftDocOrg/swiftdoc) - Documentation generator for Swift.
+55. [Jazzy](https://github.com/realm/jazzy) - Documentation generator for Swift and Objective-C.
+
+## Visual Documentation Tools
+
+*Tools for creating visual representations of APIs.*
+
+56. [Mermaid](https://mermaid-js.github.io/) - Diagramming and charting tool for documentation.
+57. [Swagger Inspector](https://inspector.swagger.io/) - API testing tool with documentation generation features.
+58. [API Flow](https://apiflow.github.io/) - Visual API designer with documentation export capabilities.
+59. [LucidChart](https://www.lucidchart.com/) - Diagramming tool useful for API architecture documentation.
+60. [Postman Visualizer](https://learning.postman.com/docs/sending-requests/visualizer/) - Visualization tool for API responses within Postman.
+61. [Flexible REST API Visualizer](https://github.com/irishadagency/flexible-rest-api) - Visualization tool for REST APIs.
+62. [Swagger UI Themes](https://github.com/ostranme/swagger-ui-themes) - Themes for Swagger UI documentation.
+63. [Speccy](https://github.com/wework/speccy) - OpenAPI specification linter with visualization features.
+
+## Documentation Hosting
+
+*Platforms for hosting and sharing API documentation.*
+
+64. [GitHub Pages](https://pages.github.com/) - Free hosting for project documentation directly from a GitHub repository.
+65. [GitBook](https://www.gitbook.com/) - Modern documentation platform for teams.
+66. [ReadTheDocs](https://readthedocs.org/) - Documentation hosting platform with full-text search.
+67. [Netlify](https://www.netlify.com/) - Platform for hosting static documentation sites.
+68. [Surge](https://surge.sh/) - Static web publishing for documentation sites.
+69. [Vercel](https://vercel.com/) - Platform for hosting documentation with seamless Git integration.
+70. [Heroku](https://www.heroku.com/) - Cloud platform that can be used to host documentation apps.
+71. [Cloudflare Pages](https://pages.cloudflare.com/) - JAMstack platform for hosting documentation sites.
+
+## API Testing with Doc Features
+
+*Tools that combine API testing with documentation capabilities.*
+
+72. [SoapUI](https://www.soapui.org/) - API testing tool with documentation features for REST and SOAP APIs.
+73. [Pact](https://docs.pact.io/) - Contract testing tool with documentation for microservices.
+74. [Dredd](https://github.com/apiaryio/dredd) - API testing tool that validates API descriptions against implementation.
+75. [HTTPie](https://httpie.io/) - Command-line HTTP client with documentation generation capabilities.
+76. [REST-Assured](https://rest-assured.io/) - Java testing library with documentation features for REST APIs.
+77. [Karate](https://github.com/karatelabs/karate) - API test automation with documentation capabilities.
+78. [Chakram](https://github.com/dareid/chakram) - API testing framework with documentation features.
+
+## IDE Extensions & Plugins
+
+*Extensions for integrating API documentation into development environments.*
+
+79. [OpenAPI (Swagger) Editor for VS Code](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi) - OpenAPI editor for Visual Studio Code.
+80. [OpenAPI Preview for VS Code](https://marketplace.visualstudio.com/items?itemName=zoellner.openapi-preview) - Preview OpenAPI documentation in Visual Studio Code.
+81. [Swagger Viewer for VS Code](https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer) - Preview Swagger documentation in VS Code.
+82. [Swagger Plugin for IntelliJ](https://plugins.jetbrains.com/plugin/8347-swagger) - Swagger integration for IntelliJ IDEA.
+83. [ReDoc for VS Code](https://marketplace.visualstudio.com/items?itemName=mobzystems.openapi-lint-vscode) - ReDoc preview for Visual Studio Code.
+84. [OpenAPI Editor for Eclipse](https://marketplace.eclipse.org/content/openapi-editor) - OpenAPI editor for Eclipse IDE.
+85. [API Blueprint Preview for Atom](https://atom.io/packages/api-blueprint-preview) - Preview API Blueprint documentation in Atom.
+
+## Markdown Tools
+
+*Tools for creating API documentation using Markdown.*
+
+86. [Docz](https://www.docz.site/) - Documentation generator using Markdown and JSX.
+87. [MkDocs](https://www.mkdocs.org/) - Static site generator for documentation using Markdown.
+88. [Docsify](https://docsify.js.org/) - Documentation site generator without static HTML files.
+89. [Markdown-it](https://github.com/markdown-it/markdown-it) - Markdown parser with plugins for documentation features.
+90. [Remarkable](https://github.com/jonschlinkert/remarkable) - Markdown parser with extension support for documentation.
+
+## Static Site Generators for Docs
+
+*Static site generators optimized for API documentation.*
+
+91. [VuePress](https://vuepress.vuejs.org/) - Vue-powered static site generator with API documentation features.
+92. [Jekyll](https://jekyllrb.com/) - Static site generator often used for API documentation.
+93. [Hexo](https://hexo.io/) - Fast and simple static site generator with documentation themes.
+94. [Hugo](https://gohugo.io/) - Fast static site generator with documentation themes and features.
+95. [Gatsby](https://www.gatsbyjs.com/) - React-based static site generator for documentation sites.
+
+## API Design Tools
+
+*Tools that help design APIs with documentation in mind.*
+
+96. [Apicurio Studio](https://www.apicur.io/studio/) - Open-source API design studio with documentation features.
+97. [Restlet Studio](https://studio.restlet.com/) - API design tool with documentation generation capabilities.
+98. [Insomnia Designer](https://insomnia.rest/product/design/) - API design tool with documentation features.
+99. [API Sprout](https://github.com/danielgtaylor/apisprout) - Lightweight, embeddable API mock server for prototyping documentation.
+100. [Prism](https://github.com/stoplightio/prism) - Open-source HTTP mock server with API documentation features.
+
+## API Monitoring Tools
+
+*Tools for monitoring and analyzing API documentation usage.*
+
+101. [API Metrics](https://apianalytics.io/) - API analytics platform with documentation usage tracking.
+102. [Moesif](https://www.moesif.com/) - API analytics and monitoring service with documentation engagement tracking.
+103. [RapidAPI Analytics](https://rapidapi.com/products/api-analytics/) - Analytics platform for API usage with documentation tracking.
+104. [APImetrics](https://www.apimetrics.io/) - API performance monitoring with documentation usage analytics.
+105. [DocOps](https://docops.io/) - Documentation analytics and optimization platform.
+
+## Mock Servers
+
+*Mock servers for API documentation testing.*
+
+106. [Prism](https://stoplight.io/open-source/prism) - HTTP mock server for OpenAPI specs.
+107. [JSON Server](https://github.com/typicode/json-server) - Fake REST API server with documentation features.
+108. [Mockoon](https://mockoon.com/) - Mock API server with documentation features.
+109. [WireMock](https://wiremock.org/) - Flexible API mocking with documentation capabilities.
+110. [MockServer](https://www.mock-server.com/) - Easy mocking of REST and SOAP services for documentation.
+
+## API Gateways with Doc Features
+
+*API gateways that include documentation capabilities.*
+
+111. [Kong](https://konghq.com/) - API gateway with documentation portal features.
+112. [Tyk](https://tyk.io/) - API gateway with documentation capabilities.
+113. [APIGateway](https://aws.amazon.com/api-gateway/) - Amazon's API gateway with documentation features.
+114. [Apigee](https://cloud.google.com/apigee) - Google Cloud's API management platform with documentation.
+115. [WSO2 API Manager](https://wso2.com/api-manager/) - Open source API management platform with documentation portal.
+
+## Documentation Templates
+
+*Templates and examples for API documentation.*
+
+116. [API Documentation Template](https://github.com/jamescooke/restapidocs) - Template for REST API documentation.
+117. [API Blueprint Examples](https://github.com/apiaryio/api-blueprint/tree/master/examples) - Examples of API Blueprint documentation.
+118. [OpenAPI Examples](https://github.com/OAI/OpenAPI-Specification/tree/master/examples) - Example OpenAPI specifications.
+119. [HAL Examples](https://github.com/mikekelly/hal-browser) - Examples of HAL documentation.
+120. [API Guidelines](https://github.com/microsoft/api-guidelines) - Microsoft's guidelines for REST API design and documentation.
+
+## AI-Powered Documentation Tools
+
+*Documentation tools incorporating AI capabilities.*
+
+121. [Mintlify](https://mintlify.com/) - AI-powered documentation platform for APIs.
+122. [DeepDocs](https://www.deepdocs.dev/) - AI documentation generator for APIs.
+123. [QuickType](https://quicktype.io/) - AI-powered JSON schema generation and documentation.
+124. [Docstring AI](https://docstring.ai/) - AI-assisted documentation generator for code.
+125. [CodeDoc AI](https://www.codedoc.ai/) - AI-powered documentation generator for programming languages.
+
+## Resources
+
+*Articles, guides, and learning resources about API documentation.*
+
+126. [API Documentation Guide](https://idratherbewriting.com/learnapidoc/) - A guide to API documentation by Tom Johnson.
+127. [OpenAPI Map](https://openapi-map.apihandyman.io/) - Visual representation of the OpenAPI Specification.
+128. [DevDocs](https://devdocs.io/) - Unified API documentation browser.
+129. [API Stylebook](http://apistylebook.com/) - Collection of resources for API designers.
+130. [Nordic APIs Blog](https://nordicapis.com/blog/) - Articles on API development and documentation best practices.
+131. [The API Handyman](https://apihandyman.io/) - Blog with API design and documentation best practices.
+132. [Swagger Blog](https://swagger.io/blog/) - Articles about API development and documentation.
+133. [REST API Tutorial](https://www.restapitutorial.com/) - Tutorial on REST API design and documentation.
+134. [API Evangelist](https://apievangelist.com/) - Blog about API strategy and documentation.
+135. [API-University](https://api-university.com/) - Educational resources for API documentation and design.
+136. [JSON Schema Tools](https://json-schema.org/implementations.html) - List of tools for working with JSON Schema.
+137. [REST API Design Rulebook](https://www.oreilly.com/library/view/rest-api-design/9781449317904/) - Book on REST API design principles.
+138. [API Documentation Best Practices](https://swagger.io/resources/articles/best-practices-in-api-documentation/) - Article on best practices for API documentation.
+139. [GraphQL Documentation Guide](https://graphql.org/learn/schema/) - Guide to documenting GraphQL APIs.
+140. [RAML Documentation Guide](https://raml.org/developers/document-your-api) - Guide to documenting APIs with RAML.
+
+## Contributing
+
+Contributions welcome! Read the [contribution guidelines](contributing.md) first.
+
+---
+
+## License
+
+[![CC0](https://i.creativecommons.org/p/zero/1.0/88x31.png)](https://creativecommons.org/publicdomain/zero/1.0/)
+
+To the extent possible under law, the author has waived all copyright and related or neighboring rights to this work.