All Projects → vorce → lagun

vorce / lagun

Licence: other
Alternative UI for Open API (fka Swagger) specs

Programming Languages

elm
856 projects
HTML
75241 projects
CSS
56736 projects
Makefile
30231 projects

Projects that are alternatives of or similar to lagun

OpenDocumenter
OpenDocumenter is a automatic documentation generator for OpenAPI v3 schemas. Simply provide your schema file in JSON or YAML, then sit back and enjoy the documentation.
Stars: ✭ 137 (+705.88%)
Mutual labels:  openapi
KaiZen-OpenApi-Parser
High-performance Parser, Validator, and Java Object Model for OpenAPI 3.x
Stars: ✭ 119 (+600%)
Mutual labels:  openapi
crud
Swagger/OpenAPI builder and input validation for Go APIs
Stars: ✭ 34 (+100%)
Mutual labels:  openapi
graphql-to-openapi
Convert a graphql query + graphql schema into an openapi spec.
Stars: ✭ 31 (+82.35%)
Mutual labels:  openapi
kommentaar
Generate documentation for Go APIs
Stars: ✭ 33 (+94.12%)
Mutual labels:  openapi
OpenAPI-ObjectiveC
KKBOX Open API Developer SDK for iOS/macOS/watchOS/tvOS
Stars: ✭ 19 (+11.76%)
Mutual labels:  openapi
starling-developer-sdk
The official JavaScript development kit for building on the Starling API
Stars: ✭ 45 (+164.71%)
Mutual labels:  openapi
nexmo-oas-renderer
Render your API references, Nexmo-style!
Stars: ✭ 40 (+135.29%)
Mutual labels:  openapi
api
Typescript typings and OpenAPI v3 generator for the Revolt API.
Stars: ✭ 23 (+35.29%)
Mutual labels:  openapi
arcanist-linters
A collection of custom Arcanist linters
Stars: ✭ 64 (+276.47%)
Mutual labels:  openapi
vim-swagger-preview
A Vim plugin for previewing swagger/openAPI spec in Chrome with swagger-ui.
Stars: ✭ 19 (+11.76%)
Mutual labels:  openapi
firecracker
Stop half-done API specifications! Cherrybomb is a CLI tool that helps you avoid undefined user behaviour by validating your API specifications.
Stars: ✭ 438 (+2476.47%)
Mutual labels:  openapi
specification
GA4GH Beacon specification.
Stars: ✭ 31 (+82.35%)
Mutual labels:  openapi
Swiftgger
OpenAPI support for server side Swift projects.
Stars: ✭ 97 (+470.59%)
Mutual labels:  openapi
navi
A tiny library converting OpenAPI route definitions to Reitit routes.
Stars: ✭ 16 (-5.88%)
Mutual labels:  openapi
fastapi-azure-auth
Easy and secure implementation of Azure AD for your FastAPI APIs 🔒 B2C, single- and multi-tenant support.
Stars: ✭ 174 (+923.53%)
Mutual labels:  openapi
swagger-petstore
petstore.swagger.io
Stars: ✭ 84 (+394.12%)
Mutual labels:  openapi
prisma-generator-nestjs-dto
Generates NestJS DTO classes from Prisma Schema
Stars: ✭ 124 (+629.41%)
Mutual labels:  openapi
openapi-samples-python
Sample code demonstrating OpenAPI interactions in Python
Stars: ✭ 37 (+117.65%)
Mutual labels:  openapi
eave
优雅的接口文档制作工具 | A Restful Api Document Builder For Pythonista
Stars: ✭ 18 (+5.88%)
Mutual labels:  openapi

Lagun

An interactive web UI for Open API (2.0) specs. Think of it as an alternative to the default Swagger UI. My first project for learning and exploring Elm.

Uses:

Demo on Github pages for swagger's petstore sample API

Build

elm-make src/Main.elm --warn --output elm.js

or

make

If everything compiles fine open index.html to use Lagun. If you want to change the default specification url simply edit index.html, and modify the specUrl setting passed into Elm.Main.fullscreen. This could also be a path to a file (for example '/docs/myspec.json'). You can also set the specUrl by providing a spec query parameter to index.html. For example: http://lagunlocation.com/index.html?spec=http://speclocation/swagger

Supported specification formats

I doubt I will add support for other specs (such as RAML). PRs welcome ;)

TODO / Explore

  • Add support for remaining parameter types: formData
  • Show schema types for body parameters (ugh)
  • Show response model for http responses
  • Some tests would be fun and useful
  • Show version of Lagun somewhere on the page (bottom?)
  • Structure the code in a nicer way
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].