Beyond OpenAPI

1. diataxis-documentation-framework

   1 88 942 6.2 HTML

   A systematic approach to creating better documentation.

   

   I think people may be missing the core point of this article.

   Anton has built a new thing, https://codapi.org/ - which provides a web component that makes it easy to embed interactive code snippets for HTTP APIs, Python code and more directly in pages of documentation.

   This article demonstrates this new technology in the context of the https://diataxis.fr/ documentation framework, which recommends going beyond just straight API reference documentation and ensuring you cover tutorials, how-to guides and explanations as well.

   I think this is really cool.

2. CodeRabbit

   coderabbit.ai featured

   CodeRabbit: AI Code Reviews for Developers. Revolutionize your code reviews with AI. CodeRabbit offers PR summaries, code walkthroughs, 1-click suggestions, and AST-based analysis. Boost productivity and code quality across all major languages with each PR.

   

3. hitchstory

   2 28 95 8.5 Python

   Type-safe YAML integration tests. Tests that write your docs. Tests that rewrite themselves.

   

   Thats the reason I wrote this:

   https://github.com/hitchdev/hitchstory

   There's a REST API example.

   If your specification can be used as a test and to generate docs and the spec can be rewritten based upon program output then the maintenance cost plunges.

   It would integrate with this quite easily - the script to generate the docs and the jinja2 would need tweaking - thats all.

4. katt

   3 3 120 5.9 Erlang

   KATT (Klarna API Testing Tool) is an HTTP-based API testing tool for Erlang.

   

   What this misses is the curl response format.

   Long time ago at Klarna we used this tool: https://github.com/for-GET/katt Here's an example: https://github.com/for-GET/katt/blob/master/doc/example-http...

5. iommi

   4 3 850 9.4 Python

   Your first pick for a django power cord

   

   It's all about the tooling. I wrote my own for iommi where the html output of some code gets saved in a defined place, and then the finished documentation page embeds that html in an iframe. It's not only WAY WAY easier to maintain than a bunch of screenshots, but I found a ton of issues with the documentation after I made it so it runs all the examples and I can look at the output.

   example: https://docs.iommi.rocks/en/latest/cookbook_forms.html

   corresponding documentation/tests: https://github.com/iommirocks/iommi/blob/master/docs/test_do...

   my evil hack to get this working: https://github.com/iommirocks/iommi/blob/master/make_doc_rst... and https://github.com/iommirocks/iommi/blob/master/iommi/docs.p...

6. pytest-doctestplus

   5 1 102 8.2 Python

   Pytest plugin providing advanced doctest features

   

   That's brilliant! https://github.com/scientific-python/pytest-doctestplus seems to be similar working in the opposite direction, using the documentation source as the single location for test code. I like your approach better and wish there was more support for that pattern more generally!

7. restclient.el

   6 24 1,977 0.0 Emacs Lisp

   Discontinued HTTP REST client tool for emacs

8. vscode-restclient

   7 15 5,497 6.3 TypeScript

   REST Client Extension for Visual Studio Code

   

9. SaaSHub

   www.saashub.com featured

   SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives

   

10. stepci

    8 49 1,725 7.4 TypeScript

    Automated API Testing and Quality Assurance

    

11. verb

    9 16 584 8.9 Emacs Lisp

    HTTP client for Emacs

    

12. httpyac

    10 5 527 9.0 TypeScript

    Command Line Interface for *.http and *.rest files. Connect with http, gRPC, WebSocket and MQTT

    

Suggest a related project