Simplify your API development workflows, accelerate implementation, and guarantee strict adherence to defined contract specifications
npm install @flock/wirespecSimplify your API development workflows, accelerate implementation, and guarantee strict adherence to defined contract specifications
Wirespec is a tool that simplifies interface design using a contract-first approach, with concise, human-readable specifications as the single source of truth.
Visit wirespec.io for more information about the project.
- Generate Wirespec files: Automatically create Wirespec templates or definitions programmatically.
- Validation: Ensure your Wirespec files adhere to defined schema and specifications.
- CLI Support: Easily integrate with your development workflow using simple CLI commands.
- Integration Ready: Works well with modern JavaScript/TypeScript projects.
You can install wirespec globally or as a dev dependency in your project:
``bashInstall as a dev dependency
npm install --save-dev wirespec
Usage
$3
The
plugin can be used directly through the command line. Below are some example commands:`bash
Create a new Wirespec file
wirespec generate Validate an existing Wirespec file
wirespec validate
`$3
You can also use
in your JavaScript or TypeScript code:`javascript
import { generate, validate } from 'wirespec';// Generate a Wirespec file
generate('example.wirespec');
// Validate a Wirespec file
const isValid = validate('example.wirespec');
console.log(
Is valid: ${isValid});
`Contributing
Contributions are welcome! If you find any issues or want to suggest new features, feel free to open an issue or submit
a pull request.
See our CONTRIBUTING.md for more details
License
This project is licensed under the Apache-2.0 license.
---
Elevate your Wirespec development workflow with the