redoc
go
Our great sponsors
redoc | go | |
---|---|---|
35 | 2,067 | |
22,462 | 119,564 | |
1.7% | 1.2% | |
7.5 | 10.0 | |
8 days ago | 1 day ago | |
TypeScript | Go | |
MIT License | BSD 3-clause "New" or "Revised" License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
redoc
-
Best Software Documentation Tools
ReDoc Interactive Demo
-
Effortless API Documentation: Accelerating Development with FastAPI, Swagger, and ReDoc
ReDoc focuses on simplicity and readability, presenting the API documentation in a user-friendly format. It supports dark mode, multiple languages, and offers a seamless browsing experience for API consumers.
-
Show HN: Iām building open-source headless CMS for technical content
There are a few other 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 renderer. It really wasn't as bad as you might think, at build time we pull in the JSON version of our OAS spec and render it as a static build in our Nextjs app. Don't get me wrong, it wasn't trivial, but the benefit of having complete control over the output has been well worth it.
-
How to Connect a FastAPI Server to PostgreSQL and Deploy on GCP Cloud Run
Redoc: http://localhost:8080/redoc
-
The Best API Documentation Tools for Dev Teams in 2023
ReDoc is a tool that's similar to Swagger UI. It also takes an OAS and renders an interactive HTML page with full API documentation details; however, it has a notable difference.
-
In what cases do you use OpenAPI/Swagger code generator on front-end using files provided by backend developers?
take a look
- Alguma alma caridosa UI/UX dev, para um serviƧo pĆŗbico gratuito, livre e de cĆ³digo aberto?
-
Hacktoberfest 2022: 7 Open Source Projects to Contribute to
Redoc is an open source tool to generate API reference documentation websites from OpenAPI definitions.
-
How to find an open source ready front-end that needs a backend to get running?
FastAPI for Python has an awesome way of doing this. It comes with two choices: Swagger and Redoc, the former being more interactive while the latter is (IMO) more visually appealing. I'm sure you could implement one of these using Spring.
-
Starlite new features, benchmarks and a call for contributors and maintainers
Starlite has substantially enhanced OpenAPI (3.1) documentation - in fact, its the most complete autogenerated schema around, and it ships with Redoc, Swagger-UI and Stoplight-Elements static sites.
go
-
Building a Playful File Locker with GoFr
Make sure you have Go installed https://go.dev/.
- Fastest way to get IPv4 address from string
- We now have crypto/rand back ends that ~never fail
-
Why Go is great choice for Software engineering.
The Go Programming Language
-
OpenBSD 7.5 Released
When Go first shipped, it was already well-documented that the only stable ABI on some platforms was via dynamic libraries (such as libc) provided by said platforms. Go knowingly and deliberately ignored this on the assumption that they can get away with it. And then this happened:
https://github.com/golang/go/issues/16606
If that's not "getting burned", I don't know what is. "Trying to provide a nice feature" is an excuse, and it can be argued that it is a valid one, but nevertheless they knew that they were using an unstable ABI that could be pulled out from under them at any moment, and decided that it's worth the risk. I don't see what that has to do with "not being as broadly compatible as they had hoped", since it was all known well in advance.
-
Go's Error Handling Is Perfect
Sadly, I think that is indeed radically different from Goās design. Go lacks anything like sum types, and proposals to add them to the language have revealed deep issues that have stalled any development. See https://github.com/golang/go/issues/57644
-
Golang: out-of-box backpressure handling with gRPC, proven by a Grafana dashboard
I've been writing a lot about Go and gRPC lately:
-
Go Enums Still Suck
I have a mountain of respect for Bell Labs and its contributions to the public welfare, and a lot of respect for the current group of alumni, mostly at Google, and mostly affiliated to a greater or lesser degree with golang. I have my differences with one or two of them (Pike telegraphs a wildly overcompensated imposter syndrome, but heās almost as much of a genius as he acts like he is and who am I to judge on an overcompensated imposter syndrome, moreover when the guy in at the next desk over is Ken Thompson, who wouldnāt be a little intimidated by the legend).
With that said, golang is too opinionated for its level of adoption, too out-of-touch with emerging consensus (and Iām being generous with āemergingā here, the Either monad is more than an emerging consensus around the right default for error handling), and too insular a leadership to be, in my personal opinion, a key contender outside some narrow niches.
Iām aware that there are avid advocates for golang on HN, and that Iām liable to upset some of them by saying so, so Iām going to use some examples to illustrate my point and to illustrate that Iāve done my homework before being critical.
Many, including myself, became aware of what is now called golang via this presentation at Google in 2007 (https://youtu.be/hB05UFqOtFA) introducing Newsqueak, a language Pike was pushing back in the mid-90s with what seems to be limited enthusiasm no greater than the enthusiasm for its predecessor Squeak. Any golang hacker will immediately recognize the language taking shape on the slides.
Iāve been dabbling with golang for something like a decade now, because I really want to like it. But like a lot of the late labs stuff it seems to have suffered from the dangerous combination of the implications of Richard Gabrielās Worse is Better observation: it was simpler, faster, cheaper, and ultimately more successful to incrementally adapt innovations from Plan9 into Linux (and other Unices), to adapt innovations from sam and acme into nvim/emacs (and now VSCode), and to adapt channel-based and other principled concurrency from Newsqueak/golang (not to mention Erlang and other more full-throated endorsements of that region of the design space) into now countless other languages ranging from things like TypeScript and Rust at the high end of adoption all the way to things like Haskell at more moderate levels of adoption. Ironically enough, the success of UTF-8 (a compromise for the non-ASCII world but the compromise that made it happen at all) is this same principle in action via the same folks!
And golang would be fine as yet another interesting language serving as a testbed for more pragmatic applications of radical ideas: but itās got corporate sponsorship that puts Sun Microsystems and Java to shame in scale and scope, but done quietly enough to not set off the same alarm bells.
The best example of this is probably this GitHub issue: https://github.com/golang/go/issues/19991 (though there are countless like it). Iāve worked with Tony Arcieri, heās brilliant and humble and hard-working and while we havenāt kept in touch, I keep an eye out, and heās clearly passionate about the success of golang. But proposal after proposal for some variation of the Either monad has died on procedural grounds for nearly a decade, all while being about the only thing that everyone else agrees on in modern industrial PLT: TypeScript supports it, Rust supports it, C++ de-facto supports it via things like abseil and folly, and of course the hard-core functional community never even bothered with something worse in the modern era. You can even kind of do it, but there are intentional limitations in the way generics get handled across compilation units to ensure it never gets adopted as a community-driven initiative. Try if you donāt believe me (my golang code has a Result type via emacs lisp I wrote).
Another example is the really weird compilation chain: countless serious people have weighed in here, Iāll elide all the classics because most people making these arguments have their own favorite language and theyāve all been on HN dozens of times, but a custom assembly language is a weird thing to have done, almost no one outside the hardcore golang community thinks itās sane, the problems is creates for build systems and FFI and just everything about actually running the stuff are completely unnecessary: there are other IRs, not all of them are LLVM IR if youāve got some beef with LLVM IR, and given that go doesnāt seriously target FFI as more than a weird black sheep (cgo) thereās, ya know, assembly language. Itās a parting shot from the Plan9 diehards with the industrial clout to make it stick.
The garbage collection story is getting better but itās an acknowledged handicap in a MxN threading model context, itās not a secret or controversial even among the maintainers. See the famous āTwo Knobsā talk.
Raw pointers, sum types, dependency management, build, generics that never get there, FFI: solved problem after solved problem killed by pocket veto, explained away, minimized, all with mega-bucks, quiet as a gopher corporate sponsorship fighting a Cold War against Sun and the JVM that doesnāt exist anymore marketed by appealing to the worst instincts of otherwise unimpeachable luminaries of computing.
There is great software written in golang by engineers I aspire to as role models (TailScale and Brad respectively as maybe the best example). I had to get serious about learning golang and how to work around its ideologically-motivated own-goals because I got serious about WebRTC and Pion (another great piece of software). But it sucks. I dread working on that part of the stack.
Go enums do suck, but thatās because we pay a very heavy price for golang being mainstream at all: weāve thrown away ZooKeeper and engineer-millennia of garbage-collector work and countless other treasures, it sucks oxygen out of the room on more plausible C successors like D and Jai and Nim and Zig and V and (it pains me to admit but itās true) Rust.
Yes there is great software in golang, tons of it. Yes there are iconic legends who are passionate about it, yes it brought new stuff to the party and the mainstream.
But the cost was too high.
-
GoFetch: New side-channel attack using data memory-dependent prefetchers
It seems to be userspace accessible: https://github.com/golang/go/issues/66450
-
Memory leaks in Go
Something you should keep in mind regarding maps in Go. They don't shrink after elements are deleted runtime: shrink map as elements are deleted #20135
What are some alternatives?
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
v - Simple, fast, safe, compiled language for developing maintainable software. Compiles itself in <1s with zero library dependencies. Supports automatic C => V translation. https://vlang.io
slate - Beautiful static documentation for your API
TinyGo - Go compiler for small places. Microcontrollers, WebAssembly (WASM/WASI), and command-line tools. Based on LLVM.
Docusaurus - Easy to maintain open source documentation websites.
zig - General-purpose programming language and toolchain for maintaining robust, optimal, and reusable software.
elements - Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.
Nim - Nim is a statically typed compiled systems programming language. It combines successful concepts from mature languages like Python, Ada and Modula. Its design focuses on efficiency, expressiveness, and elegance (in that order of priority).
mkdocs
Angular - Deliver web apps with confidence š
postman-app-support - Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIsāfaster.
golang-developer-roadmap - Roadmap to becoming a Go developer in 2020