# @affinidi/api-gw-reconciler > [![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-) Latest version **1.1.0** (published 2024-06-04) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @affinidi/api-gw-reconciler pnpm add @affinidi/api-gw-reconciler yarn add @affinidi/api-gw-reconciler bun add @affinidi/api-gw-reconciler ``` ## Health **Score 35/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; large bundle. Negative: abandoned. ## Facts | | | |---|---| | Version | 1.1.0 | | Published | 2024-06-04 | | First published | 2023-10-12 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Node | >= 20.0.0 | | Dependencies | 5 | | Unpacked size | 12.1 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 6 | | Author | Marat Shakirov | | Maintainers | rohitjjw, maratsh-affinidi, robert-affinidi, standemchuk | | Keywords | cdk | ## Links - npm: https://www.npmjs.com/package/@affinidi/api-gw-reconciler - Repository: https://github.com/affinidi/api-gw-reconciler - Homepage: https://github.com/affinidi/api-gw-reconciler#readme - Issues: https://github.com/affinidi/api-gw-reconciler/issues - npm.io page: https://npm.io/package/@affinidi/api-gw-reconciler ## Dependencies (5) - [openapi-merge](https://npm.io/package/openapi-merge.md) 1.3.2 - [atlassian-openapi](https://npm.io/package/atlassian-openapi.md) ^1.0.18 - [@aws-sdk/client-s3](https://npm.io/package/@aws-sdk/client-s3.md) ^3.588.0 - [@aws-sdk/client-api-gateway](https://npm.io/package/@aws-sdk/client-api-gateway.md) ^3.588.0 - [@aws-lambda-powertools/logger](https://npm.io/package/@aws-lambda-powertools/logger.md) ^2.1.1 ## Recent versions - 1.1.0 (latest) — 2024-06-04 - 1.0.3 — 2024-01-10 - 1.0.2 — 2024-01-10 - 1.0.1 — 2023-10-19 - 1.0.0 — 2023-10-12 ## README # api-gw-reconciler [![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-) > AWS API gateway reconciler AWS API gateway reconciler checks and merges openapi schemas from services. Reconciler is cdk library construct, which could be deployed as part of AWS CDK application ## :books: Table of Contents - [Installation](#package-installation) - [Features](#battery-features) - [Usage](#rocket-usage) - [Support](#hammer_and_wrench-support) - [Contributing](#memo-contributing) - [Contributors](#contributors-) ## :package: Installation ```sh npm i @affinidi/api-gw-reconciler ``` ## :battery: Features * Merging openapi schemas from different services in one openapi schema and updating single API gateway * Checking for backwards compatibilty of schema * schema path authentication for specifc service path prefix * Pinning 1 schema to provide authorizers * Generates and publishes json api doc * Generates and publishes ReDoc HTML documentation * Token Auth for documentation ## :rocket: Usage For more complex example, take a look into [examples] ```ts //Create API gw somewhere const api = new apigateway.RestApi(this, 'api') api.root.addMethod('ANY') ``` Create reconciler ```ts //Reference apigateway in reconciler stack const restApiId = 'fe3sdf4x' restApiReference = apigateway.RestApi.fromRestApiId(this, 'restApiReference', restApiId) //Create reconsiler const reconciler = new APIGWReconciler(this, 'reconciler', { restAPI: restApiReference allowedAccounts: [ { allowedApiPathPrefix: 'service1', id: '1111111111' }, { allowedApiPathPrefix: 'service2', id: '22222222222' }, ] }) ``` Upload openapi.json schema in service stack ```ts const oas = { "openapi": "3.0.0", "paths:" : [...] ... } new BucketDeployment(this, 'openapiSchemaDeployment', { destinationBucket: this.reconciler.openApiDefinitionBucket, destinationKeyPrefix: 'service1', prune: false, sources: [Source.jsonData('openapi.json', oas)], }) ``` ## :carpentry_saw: How it works Take a look into detailed [example](/examples/) ## :hammer_and_wrench: Support Please [open an issue](https://github.com/affinidi/api-gw-reconciler/issues/new) for support. ## :memo: Contributing Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and [open a pull request](https://github.com/affinidi/api-gw-reconciler/compare/). ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
maratsh
maratsh
💻 📖 💡 🤔 🚇 🚧 📦 💬 👀 ⚠️ ✅		 Robert
Robert
👀 💻		 Yiğitcan UÇUM
Yiğitcan UÇUM
🤔 💻		 Stanislav Demchuk
Stanislav Demchuk
👀		 yaroslava-kurash
yaroslava-kurash
💻		 Dmytro Filipenko
Dmytro Filipenko
💻		 Vyatcheslav Mogilevsky
Vyatcheslav Mogilevsky
💻 👀
Raja
Raja
💻		 Anton Iskryzhytskyi
Anton Iskryzhytskyi
💻 🤔 👀		 kwekmh-affinidi
kwekmh-affinidi
👀 🛡️		 Sanjay
Sanjay
💻 📖 💡 ✅ 📢
Add your contributions
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! --- _Source: https://npm.io/package/@affinidi/api-gw-reconciler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._