rename to openapi-express-validator

cdimascio · Mar 25, 2019 · 9c27bde · 9c27bde
1 parent 17c963e
commit 9c27bde
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -1,21 +1,21 @@
 # express-openapi-validator
 
-![](https://travis-ci.com/cdimascio/express-middleware-openapi.svg?branch=master) ![](https://img.shields.io/npm/v/express-middleware-openapi.svg) [![Coverage Status](https://coveralls.io/repos/github/cdimascio/express-middleware-openapi/badge.svg?branch=master)](https://coveralls.io/github/cdimascio/express-middleware-openapi?branch=master) ![](https://img.shields.io/badge/license-MIT-blue.svg)
+![](https://travis-ci.com/cdimascio/express-openapi-validator.svg?branch=master) ![](https://img.shields.io/npm/v/express-openapi-validator.svg) [![Coverage Status](https://coveralls.io/repos/github/cdimascio/express-openapi-validator/badge.svg?branch=master)](https://coveralls.io/github/cdimascio/express-openapi-validator?branch=master) ![](https://img.shields.io/badge/license-MIT-blue.svg)
 
-ExpressJs middleware that automatically validates API requests using an OpenAPI 3.0 specification,
+An OpenApi validator for ExpressJS that automatically validates API requests using an OpenAPI 3.0 specification,
 
 ## Install
 
 ```shell
-npm i express-middleware-openapi
+npm i express-openapi-validator
 ```
 
 ## Usage
 
-Register openapi validation middleware
+Install the openapi validator
 
 ```javascript
-new OpenApiMiddleware({
+new OpenApiValidator({
   apiSpecPath: './openapi.yaml',
 }).install(app);
 ```
@@ -44,7 +44,7 @@ var cookieParser = require('cookie-parser');
 var bodyParser = require('body-parser');
 var logger = require('morgan');
 var http = require('http');
-var OpenApiMiddleware = require('express-middleware-openapi').OpenApiMiddleware;
+var OpenApiValidator = require('express-openapi-validator').OpenApiValidator;
 var app = express();
 
 app.use(bodyParser.json());
@@ -54,7 +54,7 @@ app.use(express.urlencoded({ extended: false }));
 app.use(cookieParser());
 app.use(express.static(path.join(__dirname, 'public')));
 
-new OpenApiMiddleware({
+new OpenApiValidator({
   apiSpecPath: './openapi.yaml',
 }).install(app);
 

diff --git a/assets/express-middleware-openapi.png b/assets/express-middleware-openapi.png
diff --git a/example/app.js b/example/app.js
@@ -4,7 +4,7 @@ var cookieParser = require('cookie-parser');
 var bodyParser = require('body-parser');
 var logger = require('morgan');
 var http = require('http');
-var OpenApiMiddleware = require('express-middleware-openapi').OpenApiMiddleware;
+var OpenApiValidator = require('express-openapi-validator').OpenApiValidator;
 var app = express();
 
 app.use(bodyParser.json());
@@ -14,7 +14,7 @@ app.use(express.urlencoded({ extended: false }));
 app.use(cookieParser());
 app.use(express.static(path.join(__dirname, 'public')));
 
-new OpenApiMiddleware({
+new OpenApiValidator({
   apiSpecPath: '../openapi.yaml',
 }).install(app);
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "express-openapi-validator",
-  "version": "0.2.32-beta",
+  "version": "0.3.33-beta",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

diff --git a/src/index.ts b/src/index.ts
@@ -7,11 +7,11 @@ import ono from 'ono';
 
 const loggingKey = 'express-middleware-openapi';
 
-export interface OpenApiMiddlewareOpts {
+export interface OpenApiValidatorOpts {
   apiSpecPath: string;
 }
 
-export function OpenApiMiddleware(options: OpenApiMiddlewareOpts) {
+export function OpenApiValidator(options: OpenApiValidatorOpts) {
   if (!options.apiSpecPath) throw ono('apiSpecPath required');
 
   const openApiContext = new OpenApiContext({ apiDoc: options.apiSpecPath });
@@ -24,7 +24,7 @@ export function OpenApiMiddleware(options: OpenApiMiddlewareOpts) {
   this.context = openApiContext;
 }
 
-OpenApiMiddleware.prototype.install = function(app: ExpressApp) {
+OpenApiValidator.prototype.install = function(app: ExpressApp) {
   const pathParams = [];
   for (const route of this.context.routes) {
     if (route.pathParams.length > 0) {

diff --git a/test/app.ts b/test/app.ts
@@ -4,7 +4,7 @@ var cookieParser = require('cookie-parser');
 var bodyParser = require('body-parser');
 var logger = require('morgan');
 
-const { OpenApiMiddleware } = require('../src');
+const { OpenApiValidator } = require('../src');
 const { startServer, routes } = require('./app.common');
 
 var app = express();
@@ -16,7 +16,7 @@ app.use(express.urlencoded({ extended: false }));
 app.use(cookieParser());
 app.use(express.static(path.join(__dirname, 'public')));
 
-new OpenApiMiddleware({
+new OpenApiValidator({
   apiSpecPath: './openapi.yaml',
 }).install(app);
 

diff --git a/test/middleware.spec.ts b/test/middleware.spec.ts
@@ -1,10 +1,10 @@
 const expect = require('chai').expect;
-const { OpenApiMiddleware } = require('../src');
+const { OpenApiValidator } = require('../src');
 const packageJson = require('../package.json');
 
 describe(packageJson.name, () => {
   it('should succeed when spec exists and is valid', async () => {
-    const oam = new OpenApiMiddleware({
+    const oam = new OpenApiValidator({
       apiSpecPath: './openapi.yaml',
       enableObjectCoercion: true, // should be default
     });
@@ -16,7 +16,7 @@ describe(packageJson.name, () => {
 
   it('should throw when spec is missing', async () => {
     const createMiddleware = () =>
-      new OpenApiMiddleware({
+      new OpenApiValidator({
         apiSpecPath: './not-found.yaml',
         enableObjectCoercion: true, // should be default
       });