Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dataleonlabs/yap
Open source API Gateway on GraphQL for serverless. Less code, safer API. 💪
https://github.com/dataleonlabs/yap
api api-gateway graphql lambda-functions nodejs serverless serverless-functions typescript xml-policies
Last synced: 3 months ago
JSON representation
Open source API Gateway on GraphQL for serverless. Less code, safer API. 💪
- Host: GitHub
- URL: https://github.com/dataleonlabs/yap
- Owner: dataleonlabs
- License: apache-2.0
- Created: 2019-12-09T18:20:39.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T01:40:06.000Z (almost 2 years ago)
- Last Synced: 2024-08-04T20:23:17.174Z (3 months ago)
- Topics: api, api-gateway, graphql, lambda-functions, nodejs, serverless, serverless-functions, typescript, xml-policies
- Language: TypeScript
- Homepage: https://manual.youngapp.co/community/
- Size: 1.66 MB
- Stars: 110
- Watchers: 7
- Forks: 13
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
We love contributors, you can contribute or click ⭐️ (see above :arrow_upper_right:) to support us. Follow our news 🏅 on [Twitter](https://twitter.com/youngapp_pf) and [Slack](https://join.slack.com/t/yapcommunity/shared_invite/enQtOTA2NTcxNjc1OTI2LTA3YmNjMWRhY2E1NjdkODE2MjU4ZTcxZmU0ZmYyMzkyMDliYjM3Nzk4YzI1NTEzYjA1MjYxNWJlNGFlMjIzMDY).
# Less code, safer API.
[](https://github.com/youngapp/yap/blob/master/CONTRIBUTING.md)  [](https://www.codacy.com/gh/youngapp/yap?utm_source=github.com&utm_medium=referral&utm_content=youngapp/yap&utm_campaign=Badge_Grade)  [](https://requires.io/github/youngapp/yap/requirements/?branch=master)
Yap is the lightweight microservices API gateway with GraphQL that shines at the heart of any microservices or serverless architecture, which aims to be a smaller, more expressive, and more robust foundation with low-code approach and security entreprise-gradle.
Please distinguish **Yap** (the core project of Young App) and **YAP** (the platform of Young App).
## Motivation
Young App helps to automate business workflows across cloud and on-premise apps providing employees with prompt communication and building in teams sophisticated collaboration. As an illustration, YAP automates quotes processing for cash business, which may involve multiple apps.
Without API Management, we are using Express, Koa or Hapi on Nodejs without security handler, and all others NodeJS frameworks are based on http module, yap is different, designed only for serverless functions (event-driven) and GraphQL.
## Key features of Yap 🙌
Yap offers powerful, yet lightweight features that allow fine-grained control over your API ecosystem.
* **Elegants XML Policies** – Policies are a powerful capability of the system that allow the publisher to change API behavior through configuration in elegants with XML
* **GraphQL as API Gateway** – GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. Yap use only GraphQL as API Gateway.
* **API Connectors** – YAP is the only integration platform that was built from the ground to support a single design interface for developer/IT and for citizen integrators.
## Installing
It's an official version for JavaScript, available for Node.js backends, Serverless and AWS Lambda.
###### With yarn
```
yarn install @youngapp/yap
```
###### With npm
```
npm install @youngapp/yap
```
## Hello API
Yap application is an object containing resolvers functions and policies which are composed and executed in a stack-like manner upon request. Yap is similar to many other middleware systems that you may have encountered such as Koa, Connect.
#### Minimalist application with http.Server
```typescript
import { Yap } from "@youngapp/yap";
import typeDefs from "./schema.graphql";
import resolvers from "./resolvers.ts";
// Your schema definition and resolvers GraphQL
const app = new Yap({ typeDefs, resolvers });
app.listen(3000, () => {
console.log('Example app listening on port 3000!')
})
```
#### With AWS Lambda
```typescript
import { Yap } from "@youngapp/yap";
import typeDefs from "./schema.graphql";
import resolvers from "./resolvers.ts";
// Your schema definition and resolvers GraphQL
const app = new Yap({ typeDefs, resolvers });
// A simple handler for AWS Lambda.
exports.handler = app.handler;
```
Find more details on [Usage guide](https://manual.youngapp.co/community/usage-and-getting-started)
Enjoy 🎉
## Documentation
- [Usage guide](https://manual.youngapp.co/community/usage-and-getting-started)
- [Gateway](https://manual.youngapp.co/community/application-and-middlewares)
- [Connectors](https://manual.youngapp.co/community/connectors)
- [Policies](https://manual.youngapp.co/community/policies)
- [Error handling](https://manual.youngapp.co/community/error-handling)
- [Yap for Express Users](https://manual.youngapp.co/community/faq/faq-error-policies)
- [FAQ](https://manual.youngapp.co/community/faq/frequently-asked-questions)
## Opening issues
If you encounter a bug with YAP, we would appreciate if you inform us about it.
Before opening a new issue, please go through [existing issues](https://github.com/youngapp/yap/issues)
to find the solution right away if your problem was solved before.
Attach the following details if appropriate:
- SDK, Node.js
- Environment and OS
- Stack trace
The GitHub issues are intended for bug reports and feature requests.
For quick help and questions on using the Yap SDK for JavaScript, please use the resources listed within [Getting Help](https://github.com/youngapp/yap#getting-help) section. The time of our support experts is rushingly flying but even so, they would like to help you in time, and therefore, will appreciate your help in applying for support reasonably by providing full details and excluding duplicated issues.
## Contribute
Yap is the open source and we love contributions! If you have an idea for a great improvement or spy an issue you’re keen to fix, follow our [Contributing Guide](https://github.com/youngapp/yap/blob/master/CONTRIBUTING.md).
No contribution is too small – we encourage you to provide feedback and [report issues](https://github.com/youngapp/yap/issues).
## Community support 🌍
For general help using Yap, please refer to [the official Yap documentation](https://manual.youngapp.co/community/). For additional help, you can use one of these channels to ask a question:
- [StackOverflow](http://stackoverflow.com/questions/tagged/yap)
- [Slack](https://join.slack.com/t/yapcommunity/shared_invite/enQtOTA2NTcxNjc1OTI2LTA3YmNjMWRhY2E1NjdkODE2MjU4ZTcxZmU0ZmYyMzkyMDliYjM3Nzk4YzI1NTEzYjA1MjYxNWJlNGFlMjIzMDY) (Channel community)
- [GitHub](https://github.com/youngapp/yap) (Bug reports, feature requests, contributions)
- [Roadmap](https://github.com/youngapp/yap/projects/1) (Roadmap)
- [Twitter](https://twitter.com/youngapp_pf) (Get the news fast)
- [YouTube Channel](https://www.youtube.com/channel/UCPY1PeAXPQIgo29e4Z9u5cA) (Learn from Video Tutorials)
## License
This SDK is distributed under Apache License 2.0.
See [LICENSE.txt](LICENSE.txt) for more information.