YAP command line interface
Command line tool for youngapp ecosystem.
AWS's serverless Lambda functions open a world of possibilities for running on-demand, server-side code without having to run a dedicated server. However, managing service discovery, configuring API gateways, and coordinating deployments between your app and your serverless functions can quickly become overwhelming. This document will help you get started with Connector Functions on Serverless.
npx -p @youngapp/yap-cli yap-api-test apiTestDefinitions/*.yml
npx -p @youngapp/yap-cli yap-api-test dist/src/index.js apiTestDefinitions/*.yml
Runs yaml tests for your implemented api class CLI Receives two arguments:
- relative path to your implemented class (optional, default dist/src/index.js)
- relative path to yml test files with search pattern on a tail
Tests should run in mocha execution environment, and with default reporter so you can run it in your CI pipeline
Api class should implement handle method which confines to AWS lambda handler signature You can read more about youngapp yml testing here https://manual.youngapp.co/community-edition/functional-testing
npx -p @youngapp/yap-cli yap-create-project myProject
Creates project template for your serverless function, which will use Yap core as method router CLI Receives one argument
- folder name for your project. Default: myYapApp
API management is the process of creating and publishing web application programming interfaces (APIs), enforcing their usage policies, controlling access, nurturing subscriber communities, collecting and analyzing usage statistics, and reporting performance.
Follow instructions to create a custom connector with create-yap-connector
Policies are applied inside the gateway which sits between the API consumer and the managed API. The gateway receives all requests and usually forwards them unaltered to the underlying API. However a policy can apply changes to both the inbound request and outbound response.
Follow instructions to create a custom policy with create-yap-policy
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 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
- Reduced repro case
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, you can fork us on GitHub.
No contribution is too small – we encourage you to provide feedback and report issues.
This SDK is distributed under the GNU General Public License v3.0. See LICENSE.txt for more information.