Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mockoon/cli-action
GitHub Action for Mockoon CLI
https://github.com/mockoon/cli-action
api cli mock mock-api mock-data mock-server mocking mocking-server mocking-utility openapi prototyping rest rest-api server
Last synced: 17 days ago
JSON representation
GitHub Action for Mockoon CLI
- Host: GitHub
- URL: https://github.com/mockoon/cli-action
- Owner: mockoon
- License: other
- Created: 2023-07-03T13:18:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-13T20:01:20.000Z (11 months ago)
- Last Synced: 2024-05-01T09:41:31.333Z (8 months ago)
- Topics: api, cli, mock, mock-api, mock-data, mock-server, mocking, mocking-server, mocking-utility, openapi, prototyping, rest, rest-api, server
- Homepage: https://mockoon.com/cli/
- Size: 17.6 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@Mockoon/cli GitHub Action
Mockoon is the easiest and quickest way to design and run mock APIs. No remote deployment, no account required, free and open-source.
It combines a [desktop application](https://mockoon.com/download/) to design and run mock servers locally, and a [CLI](https://mockoon.com/cli/) to self-host your fake APIs. A [cloud](#subscribe-to-mockoon-cloud) is also available to collaborate with your team, keep your data in sync, and deploy your mock APIs.
API mocking helps you speed up development and third-party API integration by reducing dependency on external services and their limitations: rate limits, costs, availability, etc.
It also allows you to test your applications in a controlled environment with predictable responses, status codes, and latencies, and easily simulate edge cases and error scenarios.
Finally, you can onboard new team members faster by providing them with a consistent and reliable environment to test and develop their applications.
➡️ [Download](https://mockoon.com/download/)
## GitHub Action Usage
Mockoon CLI, being a JavaScript application, can run on any environment where Node.js is installed, including continuous integration systems like GitHub Actions.
This GitHub Action allows you to run Mockoon CLI in your workflows.
Several parameters are available to customize the behavior of the action:
- The `version` of the CLI, default to `latest`.
- The `data-file`, pointing to a [Mockoon data file](https://mockoon.com/docs/latest/mockoon-data-files/data-storage-location/) stored in the repository.
- A `port` on which the mock server will run, default to `3000`.
```yaml
name: Mockoon CLI demo
on:
push:
branches:
- main
jobs:
mockoon-cli-demo:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Run Mockoon CLI
uses: mockoon/cli-action@v2
with:
# Mockoon CLI version, default to 'latest'
version: "latest"
# Mockoon local data file or URL
data-file: "./mockoon-data.json"
# port, default to 3000
port: 3000
- name: Make test call
run: curl -X GET http://localhost:3000/endpoint
```
## Mockoon version compatibility
This action is compatible with the following Mockoon CLI versions:
| Mockoon CLI version | Action version |
| ------------------- | -------------- |
| <6.0.0 | v1 |
| >=6.0.0 | v2 |
## CLI's documentation
Mockoon CLI is available as an [NPM package](https://www.npmjs.com/package/@mockoon/cli). Please check our [dedicated documentation](https://github.com/mockoon/mockoon/blob/main/packages/cli/README.md) to learn how to install and use it.
## Subscribe to Mockoon Cloud
With advanced features for solo developers and teams, Mockoon Cloud supercharges your API development:
- ☁️ [cloud deployments](https://mockoon.com/docs/latest/mockoon-cloud/api-mock-cloud-deployments/)
- 🔄️ [data synchronization and real-time collaboration](https://mockoon.com/docs/latest/mockoon-cloud/data-synchronization-team-collaboration/)
- 🤖 [AI powered API mocking](https://mockoon.com/ai-powered-api-mocking/)
- 📃 Access to dozens of [ready-to-use JSON templates](https://mockoon.com/templates/).
- 💬 Priority support and training.
Upgrade today and take your API development to the next level.
## Mockoon's documentation
You will find Mockoon's [documentation](https://mockoon.com/docs/latest/about/) on the official website. It covers Mockoon's most complex features. Feel free to contribute or ask for new topics to be covered.
## Changelogs
You will find Mockoon applications [changelogs](https://mockoon.com/releases/) on the official website.
## Support/feedback
You can discuss all things related to Mockoon and ask for help on the [official community](https://github.com/mockoon/mockoon/discussions). It's also a good place to discuss bugs and feature requests before opening an issue on this repository. For more chat-like discussions, you can also join our [Discord server](https://discord.gg/FtJjkejKGp).
## Contributing
If you are interested in contributing to Mockoon, please take a look at the [contributing guidelines](https://github.com/mockoon/mockoon/blob/main/CONTRIBUTING.md).
Please also take a look at our [Code of Conduct](https://github.com/mockoon/mockoon/blob/main/CODE_OF_CONDUCT.md).
## Roadmap
If you want to know what will be coming in the next release you can check the global [Roadmap](https://mockoon.com/public-roadmap/).
New releases will be announced on Mockoon's [Twitter account @GetMockoon](https://twitter.com/GetMockoon) and through the newsletter to which you can subscribe [here](https://mockoon.com/newsletter/).