{"repo":"grafana/openapi-to-k6","free":true,"listed":false,"github":"https://github.com/grafana/openapi-to-k6","clone":"git clone https://github.com/grafana/openapi-to-k6.git","description":"A CLI tool to convert an OpenAPI schema to a TypeScript client to use with k6.","language":"TypeScript","stars":75,"topics":["api-development","api-testing","code-generation","devops","k6","load-testing","openapi","performance-testing","test-automation","testing-tools"],"license":"AGPL-3.0","category":"dev-tools","readme_excerpt":"Overview The openapi-to-k6 repository is a tool designed to simplify the process of writing k6 scripts. It generates a TypeScript client from an OpenAPI specification that you can import in your k6 script to easily call your endpoints and have auto-completion in your IDE. This lets developers easily create performance tests for their APIs based on their existing OpenAPI documentation. Along with the client, it also generates a sample k6 script as an example of how to use the client. The generated client exports a class with methods for each endpoint in the OpenAPI specification. You can create an instance of the class and use the methods to call the endpoints. To see examples of the generated client and sample script, check out the examples directory. Getting started 1. Install the tool globally via: 2. To start using the tool, either give the path to your OpenAPI schema file or provide a URL to your OpenAPI schema and the output path where you want to generate the client files: This will generate a TypeScript client and a sample k6 script in the corresponding directory. You can also supply the optional flag --include-sample-script to also generate a sample k6 script along with the client. 💡 Note : The tool supports both JSON and YAML format for OpenAPI schemas. Options The following are some of the configuration options supported by the tool: 1. --mode or -m : Specify the mode to use for generating the client. The following options are available: 1. single : This is the def","default_branch":null,"files":null,"tree":[],"storefront":"/r/grafana","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/grafana/openapi-to-k6/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}