Hacker GitHub

← All repos

Redocly/redoc

View on GitHub ↗ ★ 25,997 TypeScript

📘 OpenAPI/Swagger-generated API Reference Documentation

15 mentions on Hacker News by 13 people: 2 stories, 13 comments · first 2016-08-03 · latest 2024-09-22

Mentions per year 15 mentions · busiest year 2017 (6)
20082026
AllStoriesComments NewestTopOldest
  1. OpenAPI is great, we use it in combination with redoc ( https://github.com/Redocly/redoc ) to have a almost 0 effort API for our product. But man, my tokenizer is in trouble with OpenAPI and OpenAI.
    comment by zurfer · 2024-09-22 · in Analyzing the OpenAPI Tooling Ecosystem
  2. …tools out there that are at least marginally better than the default Swagger UI such as ReDoc ( https://github.com/Redocly/redoc ). When we redid the Mux docs ( https://docs.mux.com/api-reference ) we actually just decided to build our own…
    comment by mmcclure · 2023-06-14 · in Show HN: I’m building open-source headless CMS for technical content
  3. Did you try https://github.com/Redocly/redoc ?
    comment by johnx123-up · 2022-02-08 · in Building API Docs
  4. …not a holy grail either. [0]: https://developer.atlassian.com/cloud/ [1]: https://gohugo.io [2]: https://github.com/Redocly/redoc
    comment by caspar · 2022-01-09 · in Show HN: BookStack – An open source wiki platform and alternative to Confluence
  5. …solid and they have good compatibility with all the nooks and crannies of the OpenAPI v3 spec. 1. https://github.com/Redocly/redoc 2. https://swagger.io/tools/swaggerhub 3. https://studio.apicur.io
    comment by smt88 · 2020-10-24 · in Show HN: A faster way to prototype your APIs using OpenAPI 3 and Swagger UI
  6. …Something about the way redoc looks and the way it is served makes me want to pick them over slate. https://github.com/Redocly/redoc I've managed to get both the companies I work at use redoc instead of slate :)
    comment by roopakv · 2020-08-18 · in Slate, create beautiful, responsive API documentation
  7. …when done in YAML format, with the help of "feedback loops" per ReDoc[1] and Swagger Editor[2]. [1] https://github.com/Rebilly/ReDoc/ [2] http://editor.swagger.io/
    comment by michaelsbradley · 2017-10-24 · in Paw – macOS HTTP client for testing and describing APIs
  8. …[4] http://www.yaml.org/ [5] https://github.com/yoshiki/yaml-mode [6] http://json-schema.org/ [7] https://github.com/Rebilly/ReDoc/
    comment by michaelsbradley · 2017-10-23 · in Swagger is now the OpenAPI Specification
  9. Scroll down, https://github.com/Rebilly/ReDoc
    comment by dewey · 2017-03-30 · in Studio Ghibli API
  10. …like the site was generated by this [0]. They'd probably appreciate someone raising an issue. [0] https://github.com/Rebilly/ReDoc
    comment by nxrabl · 2017-03-30 · in Studio Ghibli API
  11. ReDoc looks pretty good - https://github.com/Rebilly/ReDoc I particularly like its approach to presenting hierarchical data structures.
    comment by mhw · 2017-03-22 · in A Visual Guide to What's New in Swagger 3.0
  12. …at every request. For the rest: http://www.javabeat.net/rest-api-best-practices/ And documentation: https://github.com/Rebilly/ReDoc/blob/master/README.md There many more comprehensive resources about sane API design (use HATEOAS,…
    comment by atmosx · 2016-10-15 · in Ask HN: Rest api authorization
  13. …Specification has been a great resource for internal and external projects. With viewers like https://github.com/Rebilly/ReDoc/ it gets pretty easy to take the spec and generate something pleasing for a consuming developer. Unless you are…
    comment by krsyoung · 2016-10-14 · in Ask HN: How do you write API documentation?