RESTful service to provide API linting as-a-service

Last update: Mar 14, 2022

Related tags

Overview

API Linting Service

Prerequisites / general idea

General idea behind this API implementation is to provide an API as a service based on the awesome spectral schema linter and it´s nodeJS based SDK.

Main Technologies

Spectral API Validation

The API is build on top of the @stoplight/spectral-core SDK for nodeJS to execute API validations that follow the "Open API Specification" pattern. Spectral itself is Open Source and able to validate any json or yaml defined schemas with dedicated rulesets, while playing it´s strengths definitely in validation of OpenAPI Specs.

Build / Setup the local dev env

First make sure to have installed the following OS dependencies for development:

Docker Desktop
node LTS
IDE of your choice like Visual Studio Code

Download all local development dependencies via (just for code completion, code will be executed in docker):

$ npm install

Build the Docker-Compose based local dev environment

$ docker-compose build --no-cache

Install the spectral-cli since it's needed in the pre-commit hook

$ npm install -g @stoplight/spectral-cli

Running the API in "debug" mode

Per default the API runs in "debug" mode during local development.

You should always start the API using Docker-Compose.

$ docker-compose up (-d)

Running the API in "prod" mode

$ docker-compose -f dcp.yml up (-d)

JS rules migration at application start up

The API downloads a dedicated spectral ruleset behind a configurable url as a base for further migration of this files into JavaScript. No need to redeploy the application after changing your spectral ruleset, restart is enough and you get served with your recently updated and published ruleset.

Without changing the download url the API uses SchwarzIT API Rules as default for API linting.

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Comments

Removed auth

Basic auth was removed from the openapi spec. It's prefered to handle authentication for the service using an other service in front of it, like a reverse proxy or api gateway.

opened by markbrockhoff 2
Fix utf8 crash
Fixed a bug where the linter would return an unexpected HTTP code 500 for specs using weird utf-8 characters

Updated all dependencies related to spectral to the newest version
opened by markbrockhoff 1
Fix highest severity
Fixed the property 'highestSeverity' of the response of lintings. Now it's always present, even if the highest severity is just e.g. warn.

Fixed the npm scripts for running tests so the service can be tested in e.g. watchmode

Updated the commited and migrated rules

Added the spectral-cli as a dev dependency and linked it to the pre-commit hook, so it does not have to be installed manually
opened by markbrockhoff 0

Remix Stack for deploying to Vercel with remix-auth, Planetscale, Radix UI, TailwindCSS, formatting, linting etc. Written in Typescript.

Remix Synthwave Stack Learn more about Remix Stacks. npx create-remix --template ilangorajagopal/synthwave-stack What's in the stack Vercel deploymen

Dec 25, 2022

RESTful service to provide API linting as-a-service

Related tags

Overview

API Linting Service

Prerequisites / general idea

Main Technologies

Spectral API Validation

Build / Setup the local dev env

Running the API in "debug" mode

Running the API in "prod" mode

JS rules migration at application start up

Test

You might also like...

WPPConnect/WA-JS API SERVER is a small api server to provide url preview for @wppconnect/wa-js library

Code Scanning/SAST/Static Analysis/Linting using many tools/Scanners with One Report - Scanmycode Community Edition (CE)

Visual Studio Code extension for formatting and linting Django/Jinja HTML templates using djLint

The Remix Stack for deploying to AWS with DynamoDB, authentication, testing, linting, formatting, etc.

The Remix Stack for deploying to Fly with Supabase, authentication, testing, linting, formatting, etc.

The Remix Blog Stack for deploying to Fly with MDX, SQLite, testing, linting, formatting, etc.

The Remix Stack for deploying to Fly with SQLite, authentication, testing, linting, formatting, etc.

The Remix Stack for deploying to Fly with PostgreSQL, authentication, testing, linting, formatting, etc.

Remix Stack for deploying to Vercel with remix-auth, Planetscale, Radix UI, TailwindCSS, formatting, linting etc. Written in Typescript.

Comments

Removed auth

Fix utf8 crash

Fix highest severity

Owner

Schwarz IT

The Remix Stack for deploying to Vercel with testing, linting, formatting, structure and mock for 3rd party API integration.

A file sharing service, where you can upload files and provide a download link for anyone on the internet by sharing the link 🔗 or via mail ✉️ which remains active for 24hours 🕙.

RESTful API using Hapi NodeJs Framework. This app is project from Dicoding Couses, Belajar Membuat Aplikasi Back-end untuk Pemula

MiniSense RESTful API

🎵 simple and RESTful API for getting lyrics of any song made using Next.js and ChakraUI.

A dockerized uptime monitoring RESTful API server that allows authenticated users to monitor URLs

Here's a RESTful API that interacts with a PostgreSQL database written in NodeJS with Typescript, RESTify, and Sequelize ORM.

Uptime monitoring RESTful API server that allows authenticated users to monitor URLs, and get detailed uptime reports about their availability, average response time, and total uptime/downtime.

A RESTful API for Bing wallpaper to use easy.

A RESTful API to support online store.