Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/airtasker/spot
Spot is a concise, developer-friendly way to describe your API contract.
https://github.com/airtasker/spot
api-blueprint dsl json-schema openapi openapi3 swagger typescript
Last synced: 5 days ago
JSON representation
Spot is a concise, developer-friendly way to describe your API contract.
- Host: GitHub
- URL: https://github.com/airtasker/spot
- Owner: airtasker
- License: other
- Created: 2018-10-11T09:55:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-11-20T14:55:04.000Z (2 months ago)
- Last Synced: 2025-01-09T13:26:17.505Z (12 days ago)
- Topics: api-blueprint, dsl, json-schema, openapi, openapi3, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 7.36 MB
- Stars: 559
- Watchers: 50
- Forks: 38
- Open Issues: 78
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Spot
**Spot** (_"Single Point Of Truth"_) is a concise, developer-friendly way to describe your API contract.
Leveraging the TypeScript syntax, it lets you describe your API and generate other API contract formats you need (OpenAPI, Swagger, JSON Schema).
You don't need to use TypeScript in your codebase to benefit from using Spot.
Example of an API definition file `api.ts` which defines a single `POST` endpoint to create a user:
```typescript
import { api, endpoint, request, response, body } from "@airtasker/spot";
@api({
name: "My API"
})
class Api {}
@endpoint({
method: "POST",
path: "/users"
})
class CreateUser {
@request
request(@body body: CreateUserRequest) {}
@response({ status: 201 })
response(@body body: CreateUserResponse) {}
}
interface CreateUserRequest {
firstName: string;
lastName: string;
}
interface CreateUserResponse {
firstName: string;
lastName: string;
role: string;
}
```
## Getting Started
Get started with writing Spot contracts - [Spot Guide](https://github.com/airtasker/spot/wiki/Spot-Guide)
For all available syntax, see [Spot Syntax](https://github.com/airtasker/spot/wiki/Spot-Syntax)
### Installation
With [yarn](https://yarnpkg.com/en/docs/usage) installed and initialized add `@airtasker/spot` to your project:
```sh
yarn add @airtasker/spot
```
You can pass the definition above to a generator by simply running:
```sh
npx @airtasker/spot generate --contract api.ts
```
# Why we built Spot
At first glance, you may wonder why we bothered building Spot. Why not use OpenAPI (formely known as Swagger) to describe your API?
At the core, we built Spot because we wanted a better developer experience.
## Writing contracts
OpenAPI documents are stored as YAML files, following a very specific schema. You won’t know that you used the wrong field name or forgot to wrap a type definition into a schema object unless you run a good OpenAPI linter. Most developers who aren’t intimately familiar with the OpenAPI specification end up using a visual editor such as Swagger Editor or Stoplight.
Since Spot leverages the TypeScript syntax, all you need is to write valid TypeScript code. Your editor will immediately tell you when your code is invalid. It will tell you what’s missing, and you even get autocomplete for free. We could have picked any other typed language—TypeScript just happened to be one of the most concise and ubiquitous for us.
## Reviewing contracts
We believe that API contracts should be checked into Git, or whichever code versioning system you use. In addition, API contracts should be systematically peer reviewed. It’s far too easy for a backend engineer to incorrectly assume what client engineers expect from an endpoint.
Because of their complex nested structure and the richness of the OpenAPI specification, OpenAPI documents can be difficult to review in a pull request. They’re great for machines, but not always for humans.
Spot aims to be as human-readable as possible. We’ve seen developers become a lot more engaged in discussions on pull requests for Spot contracts, compared to our previous OpenAPI documents.
## Interoperability with various formats
Depending on what you're trying to achieve (testing, documentation, client code generation…), you'll find tools that only work with OpenAPI 2 (Swagger), and newer tools that only support OpenAPI 3. You may also find tools for a different API ecosystem such as JSON Schema or API Blueprint.
We built Spot with this in mind. Instead of having to juggle various API format converters, Spot can generate every major API document format. This is why we called it "Single Point Of Truth".
[](https://oclif.io)
[](https://npmjs.org/package/@airtasker/spot)
[](https://circleci.com/gh/airtasker/spot/tree/master)
[](https://npmjs.org/package/@airtasker/spot)
[](https://github.com/airtasker/spot/blob/master/package.json)
* [Spot](#spot)
* [Why we built Spot](#why-we-built-spot)
* [Usage](#usage)
* [Commands](#commands)
# Usage
To get started and set up an API declaration in the current directory, run:
```
npx @airtasker/spot init
```
You can then run a generator with:
```
npx @airtasker/spot generate --contract api.ts
```
## In Memory Usage
```ts
import { Spot } from "@airtasker/spot";
const contract = Spot.parseContract("./api.ts")
const openApi = Spot.OpenApi3.generateOpenAPI3(contract);
console.log(openApi);
/*
{
openapi: '3.0.2',
info: { title: 'my-api', description: undefined, version: '0.0.0' },
paths: { '/users': { post: [Object] } },
components: {
schemas: { CreateUserRequest: [Object], CreateUserResponse: [Object] },
securitySchemes: undefined
},
security: undefined
}
*/
```
# Commands
* [`spot checksum SPOT_CONTRACT`](#spot-checksum-spot_contract)
* [`spot docs SPOT_CONTRACT`](#spot-docs-spot_contract)
* [`spot generate`](#spot-generate)
* [`spot help [COMMAND]`](#spot-help-command)
* [`spot init`](#spot-init)
* [`spot lint SPOT_CONTRACT`](#spot-lint-spot_contract)
* [`spot mock SPOT_CONTRACT`](#spot-mock-spot_contract)
* [`spot validate SPOT_CONTRACT`](#spot-validate-spot_contract)
* [`spot validation-server SPOT_CONTRACT`](#spot-validation-server-spot_contract)
## `spot checksum SPOT_CONTRACT`
Generate a checksum for a Spot contract
```
USAGE
$ spot checksum SPOT_CONTRACT
ARGUMENTS
SPOT_CONTRACT path to Spot contract
OPTIONS
-h, --help show CLI help
EXAMPLE
$ spot checksum api.ts
```
_See code: [build/cli/src/commands/checksum.js](https://github.com/airtasker/spot/blob/v1.13.0/build/cli/src/commands/checksum.js)_
## `spot docs SPOT_CONTRACT`
Preview Spot contract as OpenAPI3 documentation. The documentation server will start on http://localhost:8080.
```
USAGE
$ spot docs SPOT_CONTRACT
ARGUMENTS
SPOT_CONTRACT path to Spot contract
OPTIONS
-h, --help show CLI help
-p, --port=port [default: 8080] Documentation server port
EXAMPLE
$ spot docs api.ts
```
_See code: [build/cli/src/commands/docs.js](https://github.com/airtasker/spot/blob/v1.13.0/build/cli/src/commands/docs.js)_
## `spot generate`
Runs a generator on an API. Used to produce client libraries, server boilerplates and well-known API contract formats such as OpenAPI.
```
USAGE
$ spot generate
OPTIONS
-c, --contract=contract (required) Path to a TypeScript Contract definition
-g, --generator=generator Generator to run
-h, --help show CLI help
-l, --language=language Language to generate
-o, --out=out Directory in which to output generated files
EXAMPLE
$ spot generate --contract api.ts --language yaml --generator openapi3 --out output/
```
_See code: [build/cli/src/commands/generate.js](https://github.com/airtasker/spot/blob/v1.13.0/build/cli/src/commands/generate.js)_
## `spot help [COMMAND]`
display help for spot
```
USAGE
$ spot help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.3.1/src/commands/help.ts)_
## `spot init`
Generates the boilerplate for an API.
```
USAGE
$ spot init
OPTIONS
-h, --help show CLI help
EXAMPLE
$ spot init
Generated the following files:
- api.ts
- tsconfig.json
- package.json
```
_See code: [build/cli/src/commands/init.js](https://github.com/airtasker/spot/blob/v1.13.0/build/cli/src/commands/init.js)_
## `spot lint SPOT_CONTRACT`
Lint a Spot contract
```
USAGE
$ spot lint SPOT_CONTRACT
ARGUMENTS
SPOT_CONTRACT path to Spot contract
OPTIONS
-h, --help show CLI help
--has-discriminator=(error|warn|off) Setting for has-discriminator
--has-request-payload=(error|warn|off) Setting for has-request-payload
--has-response=(error|warn|off) Setting for has-response
--has-response-payload=(error|warn|off) Setting for has-response-payload
--no-inline-objects-within-unions=(error|warn|off) Setting for no-inline-objects-within-unions
--no-nullable-arrays=(error|warn|off) Setting for no-nullable-arrays
--no-nullable-fields-within-request-bodies=(error|warn|off) Setting for no-nullable-fields-within-request-bodies
--no-omittable-fields-within-response-bodies=(error|warn|off) Setting for no-omittable-fields-within-response-bodies
--no-trailing-forward-slash=(error|warn|off) Setting for no-trailing-forward-slash
EXAMPLES
$ spot lint api.ts
$ spot lint --has-descriminator=error
$ spot lint --no-nullable-arrays=off
```
_See code: [build/cli/src/commands/lint.js](https://github.com/airtasker/spot/blob/v1.13.0/build/cli/src/commands/lint.js)_
## `spot mock SPOT_CONTRACT`
Run a mock server based on a Spot contract
```
USAGE
$ spot mock SPOT_CONTRACT
ARGUMENTS
SPOT_CONTRACT path to Spot contract
OPTIONS
-h, --help show CLI help
-p, --port=port (required) [default: 3010] Port on which to run the mock server
--pathPrefix=pathPrefix Prefix to prepend to each endpoint path
--proxyBaseUrl=proxyBaseUrl If set, the server will act as a proxy and fetch data from the given
remote server instead of mocking it
--proxyFallbackBaseUrl=proxyFallbackBaseUrl Like proxyBaseUrl, except used when the requested API does not match
defined SPOT contract. If unset, 404 will always be returned.
--proxyMockBaseUrl=proxyMockBaseUrl Like proxyBaseUrl, except used to proxy draft endpoints instead of
returning mocked responses.
EXAMPLE
$ spot mock api.ts
```
_See code: [build/cli/src/commands/mock.js](https://github.com/airtasker/spot/blob/v1.13.0/build/cli/src/commands/mock.js)_
## `spot validate SPOT_CONTRACT`
Validate a Spot contract
```
USAGE
$ spot validate SPOT_CONTRACT
ARGUMENTS
SPOT_CONTRACT path to Spot contract
OPTIONS
-h, --help show CLI help
EXAMPLE
$ spot validate api.ts
```
_See code: [build/cli/src/commands/validate.js](https://github.com/airtasker/spot/blob/v1.13.0/build/cli/src/commands/validate.js)_
## `spot validation-server SPOT_CONTRACT`
Start the spot contract validation server
```
USAGE
$ spot validation-server SPOT_CONTRACT
ARGUMENTS
SPOT_CONTRACT path to Spot contract
OPTIONS
-h, --help show CLI help
-p, --port=port [default: 5907] The port where application will be available
EXAMPLE
$ spot validation-server api.ts
```
_See code: [build/cli/src/commands/validation-server.js](https://github.com/airtasker/spot/blob/v1.13.0/build/cli/src/commands/validation-server.js)_