Achtung! This library is in early development state so it's unstable. It works now, but there are no guarantees for API stability (it may change during development). We are testing this library inside our projects and adopting some features to make it feel better. Please wait for version 1.0 and don't use it inside real projects.
Specificator is a framework (you may call it collection of DTOs) designed to help you write OpenAPI 3 documentation using TypeScript and its strict type system.
All of us know it's hard to support OpenAPI 3 documentation. People use different ways to write it: Jsonnet, Go templates, JSON Pointers inside plain JSON/YAML files and many other exotic ways. Sometimes our docs become huge and hard to support; weak tools are risky for developers and they are vulnerable to mistakes. Some tools say nothing when you do something wrong: for example you may not notice a typo in a property name and your documentation may become invalid for visualization tools such as ReDoc and Swagger UI. That's because most of solutions are weak DSLs not designed for that purpose. We suggest that you stop using these solutions and start using strict frameworks such as Specificator.
For installation instructions, usage docs and examples please visit docs/README.md file.
To find community projects related to Specificator browse specificator keyword in npm registry or specificator topic in GitHub.
Serializers should be used if you need to serialize OpenAPI objects to plain JavaScript objects.
Official implementations:
- specificator-serializer. Default serializer with simple logic.
To find community implementations browse specificator-serializer keyword in npm registry or specificator-serializer topic in GitHub.
Specification extensions packages may provide additional OpenAPI objects related to specific vendors (such as ReDoc).
To find community implementations browse specificator-specification-extension keyword in npm registry or specificator-specification-extension topic in GitHub.