# oamerge

> Merge and share OpenAPI endpoints and schemas.

Latest version **0.0.3** (published 2023-02-02) · SEE LICENSE IN LICENSE.md license · 0 weekly downloads

## Install

```sh
npm install oamerge
pnpm add oamerge
yarn add oamerge
bun add oamerge
```

Provides the command `oamerge`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2023-02-02 |
| First published | 2022-07-04 |
| Weekly downloads | 0 |
| License | SEE LICENSE IN LICENSE.md |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 64.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | saibotsivad |
| Keywords | openapi, glob, generator, oamerge, merge |

## Links

- npm: https://www.npmjs.com/package/oamerge
- Repository: https://github.com/oamerge/oamerge
- Homepage: https://oamerge.com
- Issues: https://github.com/oamerge/oamerge/issues
- npm.io page: https://npm.io/package/oamerge

## Recent versions

- 0.0.3 (latest) — 2023-02-02
- 0.0.2 — 2023-01-30
- 0.0.1 — 2023-01-30
- 0.0.0 — 2023-01-24
- 0.0.0-prerelease — 2022-07-04

## README

# OpenAPI Merge

Merge and share OpenAPI endpoints and schemas.

Based on the powerful OpenAPI specs and a file-based merging system, OpenAPI Merge (OA Merge) lets you focus on the business logic of your application, instead of the redundant work of cataloging endpoints and schemas.

**Read the complete documentation at [OAMerge.com](https://oamerge.com/)**

## Introduction

Let's discover OA Merge in **less than 5 minutes**.

You'll need [Node.js](https://nodejs.org/en/download/) version 16.14 or above.

## Initialize the Project

Create a new directory and initialize `npm`:

```bash
mkdir my-api
cd my-api
npm init -y
```

Install dependencies:

```bash
npm install --save-dev oamerge @oamerge/generator-routes
```

- `oamerge` - The core CLI (this library).
- `@oamerge/generator-routes` - OA Merge is a plugin-based system, this one generates output for common routers.

## Create your API

Add an API endpoint for `GET /hello` by adding the file `api/paths/hello/get.@.js` with this:

```js
export const summary = 'Says Hello'
export const description = 'Simple example using the NodeJS http request/response model.'
export default async (request, response) => {
	response.statusCode = 200
	response.setHeader('Content-Type', 'text/plain')
	response.end('Hello World!')
}
```

## Configure OA Merge

Add a configuration file `oamerge.config.js` with this:

```js
import routes from '@oamerge/generator-routes'
export default {
	input: './api',
	output: './build',
	generators: [
		routes(),
	],
}
```

And to your `package.json` file, add a run script for building:

```json
{
	"scripts": {
		"run": "oamerge -c"
	}
}
```

## Run the Server

OA Merge *does not* have opinions about how you handle requests, but in this demo we're using a simple implementation of [NodeJS `createServer`](https://nodejs.org/api/http.html#httpcreateserveroptions-requestlistener).

Add a file `server.js` and put in it:

```js
import { createServer } from 'node:http'
import { routes } from './build/routes.js'

const server = createServer((request, response) => {
	// a very rudimentary router, as OA Merge does not ship one, on purpose!
	for (const { path, method, handler } of routes) {
		if (request.url === path && request.method.toLowerCase() === method) {
			return handler(request, response)
		}
	}
})

server.listen(3000, '127.0.0.1', () => {
	console.log('Server running!')
})
```

Now open up [`http://127.0.0.1:3000/hello`](http://127.0.0.1:3000/hello) to see the server response.

## License

This software and all example code are dedicate to the [public domain](http://en.wikipedia.org/wiki/Public_Domain).

---
_Source: https://npm.io/package/oamerge · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._