Git Product home page Git Product logo

hashicorp-consul-api's Introduction

Hashicorp Consul API

I was looking for an OpenAPI for the Hashicorp Consul API (https://www.consul.io/api/index.html) for use in one of my government projects. During my search I found this thread about OpenAPI (fka Swagger) on Consul's Github Issues (hashicorp/consul#555).

They say they don't support "Swagger Docs", but another user had created an API Blueprint, and resulting Apiary API documentation for the API (https://consul.docs.apiary.io/).

I have taken the API Blueprint and converted to OpenAPI using APIMATIC API Transformer, so that I can use the OpenAPI in my project documentation, loading into Postman for sharing with team members, testing, monitoring, and some other applications.

While it would be nice if Hashicorp Consul would maintain their own machine readable definition, this is the best we have. It is far from complete or verified, so if you improve upon it, please submit a pull request to improve upon it for everyone else.

Thanks - @kinlane

hashicorp-consul-api's People

Contributors

kinlane avatar

Stargazers

 avatar Ingvi Rafn avatar  avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.