Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mertssmnoglu/openapi-cli

A Command Line Interface (CLI) tool for serving, validating, and linting OpenAPI specifications.
https://github.com/mertssmnoglu/openapi-cli

cobra cobra-cli go go-cli golang golang-cli-app openapi openapi-spec openapi-specifications openapi-specs swagger swagger-cli

Last synced: 18 days ago
JSON representation

A Command Line Interface (CLI) tool for serving, validating, and linting OpenAPI specifications.

Host: GitHub
URL: https://github.com/mertssmnoglu/openapi-cli
Owner: mertssmnoglu
License: apache-2.0
Created: 2024-08-18T10:37:52.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-10-18T20:05:08.000Z (2 months ago)
Last Synced: 2024-11-26T20:44:36.752Z (26 days ago)
Topics: cobra, cobra-cli, go, go-cli, golang, golang-cli-app, openapi, openapi-spec, openapi-specifications, openapi-specs, swagger, swagger-cli
Language: Go
Homepage: https://pkg.go.dev/github.com/mertssmnoglu/openapi-cli
Size: 13.7 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # OpenAPI CLI

[![Go Report Card](https://goreportcard.com/badge/github.com/mertssmnoglu/openapi-cli)](https://goreportcard.com/report/github.com/mertssmnoglu/openapi-cli)

[![GoDoc](https://godoc.org/github.com/mertssmnoglu/openapi-cli?status.svg)](https://godoc.org/github.com/mertssmnoglu/openapi-cli)

![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/mertssmnoglu/openapi-cli)

A Command Line Interface (CLI) tool for serving, validating, and linting OpenAPI specifications.

## Table of Contents

- [Installation](#installation)

    - [GitHub Releases](#github-releases)

    - [Command Line](#command-line)

- [Usage](#usage)

- [License](#license)

## Installation

### GitHub Releases

Please visit the [GitHub Releases](https://github.com/mertssmnoglu/openapi-cli/releases) page to download the latest version of the OpenAPI CLI.

### Command Line

To install the latest version of the OpenAPI CLI via the command line, you can use the following command:

```shell

go install github.com/mertssmnoglu/openapi-cli@latest

```

It will automatically download the latest version of the OpenAPI CLI and install it in your `$GOPATH/bin` directory. Make sure that your `$GOPATH/bin` directory is in your `$PATH`.

## Usage

```shell

>>> openapi-cli help

A Command Line Interface (CLI) tool for serving, validating, and linting OpenAPI specifications.

Usage:

  openapi-cli [command]

Available Commands:

  completion  Generate the autocompletion script for the specified shell

  help        Help about any command

  serve       Serve the OpenAPI file

Flags:

  -h, --help   help for openapi-cli

Use "openapi-cli [command] --help" for more information about a command.

```

## License

This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.