{"repo":"go-andiamo/chioas","free":true,"listed":false,"github":"https://github.com/go-andiamo/chioas","clone":"git clone https://github.com/go-andiamo/chioas.git","description":"Go package for defining Chi apis (with OpenAPI generated specs)","language":"Go","stars":46,"topics":["api","chi","go","golang","oas","openapi","swagger","swagger-ui"],"license":"Apache-2.0","category":"api-integrations-sdks","readme_excerpt":"CHIOAS Chioas is an add-on for the popular Chi router pronounce Chioas however you like... but I can't help feeling that it looks a little like \"chaos\" - the chaos of undocumented APIs that it tries to solve! What it does Chioas does three things: Defines your API as a single (or modular) struct and then builds the Chi routes accordingly Produces an OpenApi spec (OAS) of that definition Optionally serves an interactive API docs web-page (as part of your service) Advantages With your actual API and OpenAPI spec (OAS) being specified in one place there's no chance of them becoming out of sync! (eliminating having to manually update spec yaml/json to match API or vice versa) You can even keep your request/response OAS schemas in sync with your request/response structs! See petstore example Already have an OAS spec? No problem, use chioas.FromJson() or chioas.FromYaml() to read the spec definition. All you'll need to do is add x-handler tags to each method in the spec. See From example You can also unmarshal OAS YAML/JSON directly into a Chioas Definition (but this won't bind handlers) Choice of UI styles Chioas supports three different styles of API docs UI: 1. Rapidoc (see rapidoc) 2. Swagger (see swagger-ui) 3. Redoc (see Redocly.redoc and Redoc-try) Set the desired style using DocOptions.UIStyle (the default is Redoc ). Notes: statics for Swagger are all served directly from Chioas statics for Rapidoc are all served directly from Chioas statics for Redoc are served from CDNs ","default_branch":null,"files":null,"tree":[],"storefront":"/r/go-andiamo","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/go-andiamo/chioas/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."}