mfilej
Rich documentation with Absinthe
I was thinking about autogenerating GraphQL documentation from the schema, but also having the ability to add additional content.
I found a few projects that can do this among which SpectaQL seems the most promising. On top of documenting types/fields/queries, it offers static and dynamic examples, plain markdown content, extensive design customization, etc.
Alas, it seems that the initial curve might be a bit steeper as you have to find a way to somehow enrich your schema with metadata.
From what I was able to understand it seems that Absinthe offers enough extensibility to allow this to be built on top. However, a quick web search gave me the impression that no one has attempted to do this yet.
What are your approaches to documenting your GraphQL APIs, aside from describing fields/queries/types?
First Post!
benwilson512
I think in this case it’s less about anything Absinthe specifically has, and more about GraphQL’s inherent introspection ability. Any GraphQL documentation tool would be wise to simply use introspection to get the GraphQL schema information and not anything specific to a particular implementation or language.
With that information someone can then format / display / amend any info they like. This is exactly the approach taken by SpectaQL, GitHub - anvilco/spectaql: Autogenerate static GraphQL API documentation · GitHub. Note that the weaving they are talking about is weaving metadata into the introspection result, which is just JSON.
Last Post!
benwilson512
What I’m saying is that they post process the introspection results. They don’t ask the GraphQL implementation to add anything to the result, they take the result and add things to it.
Popular in Discussions
Other popular topics
Chat & Discussions>Discussions
Latest on Elixir Forum
Sponsor Spotlight
We build reliable cloud platforms for business-critical systems.
Categories:
Sub Categories:
Forums
Popular Tags
- #ecto
- #liveview
- #troubleshooting
- #learning-elixir
- #deployment
- #library
- #erlang
- #testing
- #genserver
- #mix
- #absinthe
- #remote-other
- #otp
- #plug
- #how-to-question
- #macros
- #postgres
- #channels
- #elixirconf
- #exunit
- #discussion
- #code-sync
- #javascript
- #podcasts
- #onsite
- #dialyzer
- #docker
- #authentication
- #umbrella
- #full-time-contract
- #podcasts-by-brainlid
- #ecto-query
- #elixir-ls
- #phoenix_html
- #iex
- #blog-post
- #graphql
- #genstage
- #ai
- #websockets
- #supervisor
- #elixirconf-us
- #advent-of-code
- #distillery
- #processes
- #api
- #forms
- #metaprogramming
- #security
- #hex
Our Sponsors
Build Elixir applications with speed and confidence.
Supporting innovation across the BEAM ecosystem.
We build reliable cloud platforms for business-critical systems.
Catch errors, track performance, monitor hosts and more.
Error tracking, logs, uptime, and Just Enough APM. Built for developers.
Develop your skills with books, videos, and courses.
Producing high quality Elixir screencasts since 2017.
The deployment platform built for Elixir: PaaS ease, VPS control.
The team behind Membrane, Popcorn, LiveDebugger. Available for hire.
Courses that'll move you from confusion to "Aha, now I get it!"