website/llms.txt at main · speclynx/website · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
---
layout: none
---
# SpecLynx

> One toolchain for every API spec. Parsers, semantic data models, and intelligent editing tools for OpenAPI, AsyncAPI, Arazzo, Overlay, and JSON Schema. Local-first and open source.

## Products

### Editor
- Browser-based OpenAPI editor
- Fully client-side — no data leaves your browser
- Real-time validation, autocompletion, and live preview
- Supports OpenAPI, AsyncAPI, Arazzo, and JSON Schema in JSON and YAML
- Zero installation, no account required
- Free, open source (Apache 2.0)
- Editor: https://editor.speclynx.com
- GitHub: https://github.com/speclynx/speclynx-editor
- Docs: {{ site.url }}{{ site.baseurl }}/editor/
- Google CodeWiki (AI-generated architecture reference by Google): https://codewiki.google/github.com/speclynx/speclynx-editor

### OpenAPI Toolkit
- VS Code extension for API specification authoring
- Real-time validation, autocompletion, hover documentation, syntax highlighting, live preview
- Supports Swagger 2.0, OpenAPI 3.0.x, OpenAPI 3.1.x, AsyncAPI 2.x, Arazzo 1.x
- Works with JSON and YAML
- Free, open source (Apache 2.0)
- Install: https://marketplace.visualstudio.com/items?itemName=SpecLynx.vscode-openapi-toolkit
- Docs: {{ site.url }}{{ site.baseurl }}/openapi-toolkit/

### CLI
- Command-line tool for managing API specifications
- Apply Overlay 1.x documents to API definitions
- Generate an Overlay document by diffing two API specs (overlay diff)
- Supports any JSON or YAML document as a target
- Multiple overlay chaining, strict validation, format auto-detection
- npm package: @speclynx/cli
- Free, open source (Apache 2.0)
- GitHub: https://github.com/speclynx/speclynx-cli
- Docs: {{ site.url }}{{ site.baseurl }}/cli/

### Language Service
- LSP-compatible library for API specification intelligence
- 12+ LSP features: validation, completion, hover, go-to-definition, find references, document symbols, semantic tokens, code actions, formatting
- npm package: @speclynx/api-languageservice (formerly @speclynx/apidom-ls)
- Integrates with any LSP-compatible editor or tool
- Free, open source (Apache 2.0)
- GitHub: https://github.com/speclynx/api-languageservice
- Docs: {{ site.url }}{{ site.baseurl }}/language-service/

### ApiDOM
- Semantic parser for API specifications
- Parses OpenAPI, AsyncAPI, Arazzo, Overlay, and JSON Schema into a unified semantic element tree
- Lossless: preserves comments, key ordering, format styles, and CST source texts
- Source maps with UTF-16 code units (LSP/VS Code/Monaco compatible)
- npm packages under @speclynx/apidom-*
- Free, open source (Apache 2.0)
- GitHub: https://github.com/speclynx/apidom
- Docs: {{ site.url }}{{ site.baseurl }}/apidom/
- Google CodeWiki (AI-generated architecture reference by Google): https://codewiki.google/github.com/speclynx/apidom

## Docs

- Guides walk a problem end to end across the toolchain; tutorials solve one use case with one tool
- Index: {{ site.url }}{{ site.baseurl }}/docs/
- Getting started guide (one OpenAPI document through the Editor, VS Code, CLI, Overlay, and ApiDOM): {{ site.url }}{{ site.baseurl }}/docs/guides/getting-started/

## Blog

- Hands-on tutorials, looks inside how SpecLynx tools are built, and takes on where API tooling is heading
- Topics: OpenAPI, AsyncAPI, Arazzo, Overlay, JSON Schema
- Index: {{ site.url }}{{ site.baseurl }}/blog/
- RSS feed: {{ site.url }}{{ site.baseurl }}/feed.xml

## Links

- Website: {{ site.url }}{{ site.baseurl }}/
- GitHub: https://github.com/speclynx
- Contact: {{ site.email }}