Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neynarxyz/oas
The OpenAPI specification for the Neynar APIs
https://github.com/neynarxyz/oas
farcaster neynar openapi-specification rest-api
Last synced: 3 days ago
JSON representation
The OpenAPI specification for the Neynar APIs
- Host: GitHub
- URL: https://github.com/neynarxyz/oas
- Owner: neynarxyz
- License: mit
- Created: 2023-10-18T15:42:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-16T20:33:10.000Z (11 days ago)
- Last Synced: 2025-01-20T22:49:33.951Z (7 days ago)
- Topics: farcaster, neynar, openapi-specification, rest-api
- Homepage: https://neynar.com
- Size: 856 KB
- Stars: 16
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OAS
[](https://github.com/neynarxyz/OAS/actions/workflows/validate-oas.yml)
### Overview
The OpenAPI specification for the [Neynar](https://neynar.com) [APIs](https://docs.neynar.com).
Sign up for an API key on [neynar.com](https://neynar.com).
### Installing Spectral for OpenAPI Validation
We use [Spectral](https://github.com/stoplightio/spectral) to lint and validate our OpenAPI specifications. Spectral helps ensure that the OpenAPI files are compliant with the OpenAPI specification and follow best practices.
#### Install Spectral
You can install Spectral globally using Yarn:
```bash
yarn global add @stoplight/spectral-cli
```
### Validating OpenAPI Specifications
To validate an OpenAPI specification file using Spectral, run:
#### v1
```bash
spectral lint src/v1/spec.yaml
```
#### v2
```bash
spectral lint src/v2/spec.yaml
```
#### hub-rest-api
```bash
spectral lint src/hub-rest-api/spec.yaml
```
Spectral will output any errors or warnings found in the specification files.
### Validating OpenAPI Specifications with Swagger
In addition to Spectral, you can use the Swagger CLI to validate your OpenAPI specifications.
#### Install Swagger CLI
You can install Swagger CLI globally using Yarn:
```bash
yarn global add swagger-cli
```
#### Validate OpenAPI Specifications with Swagger CLI
To validate an OpenAPI specification file using Swagger CLI, run:
v1
```bash
swagger-cli validate src/v1/spec.yaml
```
v2
```bash
swagger-cli validate src/v2/spec.yaml
```
hub-rest-api
```bash
swagger-cli validate src/hub-rest-api/spec.yaml
```
This will check for structural errors and report any issues.
### Installing Client Code Generator
We use [OpenAPI Generator](https://openapi-generator.tech/) to generate client code from the OpenAPI specifications.
#### Install OpenAPI Generator
Prerequisite: [Java](https://www.java.com/) must be installed.
Install OpenAPI Generator using Homebrew:
```bash
brew install openapi-generator
```
### Generating TypeScript Client Code Using the OAS Definitions
#### v1
```bash
openapi-generator generate -i src/v1/spec.yaml -g typescript-axios -o src/v1/swagger-tmp
```
#### v2
```bash
openapi-generator generate -i src/v2/spec.yaml -g typescript-axios -o src/v2/swagger-tmp
```
#### hub-rest-api
```bash
openapi-generator generate -i src/hub-rest-api/spec.yaml -g typescript-axios -o src/hub-rest-api/swagger-tmp
```
For other languages, replace `` with a [desired generator](https://openapi-generator.tech/docs/generators).