Skip to content

NorthfieldIT/openapi-cue

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenAPI HTML Documentation Generator

Generates OpenAPI doc as openapi.json and public/service.yaml based on the CUE schema service.cue and deploys it to nginx Docker container. The UI served is from Stoplight Elements.

Elements is an API Documentation toolkit, leveraging OpenAPI and Markdown (CommonMark) to provide beautiful, interactive API reference documentation, that you can integrate with any existing content-management system or single-page application

Development

Be sure you don't have listener on port localhost:80 as that is where nginx is hosted.

  1. $ make

  2. Open browser http://localhost

To execute tests, use standard library. i.e.

go test -v -count=1 ./...

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published