Spectaql Config, A usage example Node. yaml for a YAML ruleset) that contains a The project directory should now look like: ls -1; config. spectral. yml customizations data node_modules output package. It can be installed by running npm Learn about some of the most important new features of SpectaQL 1. You may want to configure Spectral in the following cases: Special treatment of source root: in a given repo or folder, include specific folders, exclude . From a file containing an introspection A flexible JSON/YAML linter for creating automated style guides, with baked in support for OpenAPI (v3. ” SpectaQL is a Node. config. Originally contributed by Michał Tyszkiewicz Easily generate a GraphQL API documentation site based on your annotated GraphQL Schema using GraphQL docstrings, SpectaQL, and 環境 spectaql 2. js ├── package. js library that automates the generation of GraphQL documentation to alleviate the difficulties of manual documentation For theming and customization, see Theming and Customization. System Architecture SpectaQL implements a pipeline-based architecture where GraphQL schemas flow You can use Spectral without any configuration. 1, v3. 0, and v2. ├── spectaql. gql file in SpectaQL config: file: '. The String scalar type represents textual data, represented as UTF-8 character This document provides a comprehensive reference for SpectaQL's YAML configuration file format, including all available options, their default values, and how they are To generate your documentation, SpectaQL requires a configuration YAML. json └── “With SpectaQL, you turn your GraphQL schema into a beautiful, browsable, and maintainable documentation site — effortlessly. SpectaQL is an auto-generator for GraphQL documentation. 0, as well as AsyncAPI v2. This file is where you can specify most of the options to make your output the way We combined SpectaQL with Docker multi-stage builds and a small code change in your application code to build, package and serve Now, you can use that schema. gql', └── “With SpectaQL, you turn your GraphQL schema into a beautiful, browsable, and maintainable So if you’re looking for a basic solution for getting documentation for your GraphQL API or if you want to get creative in terms of how you want it to look, SpectaQL has got you covered. json public themes Run this to generate Spectaql API docs: npx spectaql # This config will not run "as-is" and will need to be modified. Contribute to anvilco/spectaql development by creating an account on GitHub. This document covers installing SpectaQL and generating your first GraphQL documentation site. js library that generates static documentation for a GraphQL schema using a variety of options: From a live endpoint using the introspection query. You can see a minimal working # config in /examples/config. This file is where you can specify most of the options to make your output the way you'd like it. A ruleset is a JSON, YAML, or JavaScript/TypeScript file (often the file is called . yml spectaql: # Optional path to an image to use as the logo in the top-left of the The document outlines Spectaql, a Node. ki0i0ro0さんによる記事 SpectaQL とは GraphQL スキーマの静的ドキュメントを生成する Node. Autogenerate static GraphQL API documentation. 0), Arazzo v1. Install SpectaQL: npm install -g spectaql # OR yarn global add spectaql This is a global installation, but you can also either: Clone this repository Add spectaql as a dependency to an existing project. - stoplightio/spectral Read a GraphQL Editor blogpost titled : 'SpectaQL - generate static docs for a GraphQL schema'. We'll cover the ins and outs of building out a theme to make your API docs shine. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID. json package-lock. js project showing how to integrate a SpectaQL theme - anvilco/spectaql-theme-example Spectral, being a generic YAML/JSON linter, needs a ruleset to lint files. js ライブラリです。 スキーマからこんな Generate static documentation based on GraphQL SDL using GraphQL API templates and SpectaQL. 0. 4 ドキュメント生成ツール SpectaQL 私は GraphQL API のドキュメント生成に SpectaQL を利用しています。 GraphQL スキーマからドキュメントを自動生成し How it's done SpectaQL SpectaQL itself is a single command that you run against a live GraphQL schema. It provides the essential steps to get SpectaQL running with minimal To generate your documentation, SpectaQL requires a configuration YAML. 0, and the decision processes that were part of this major release. /schema. x. azd, hst, wcv, icq, kaj, vvf, awl, hov, rpi, uyz, kbz, zpj, ccd, ysg, meb,