Comments (4)
Yes, only in the history of this repository.
The repository structure is for writing API definitions by hand. I really recommend you utilize the latest version of the spec to do that. OAS3 has been out for almost 3 years already.
from create-openapi-repo.
Thanks for the info @adamaltman
We use the latest Ruby library Grape-Swagger however that currently only produced OAS2 :(
I'm currently looking at OAS2 to OAS3 converters so we can use the latest version of create-openapi-repo. Do you think that would be feasible? Would there be any compatibility issues between the two specs (I'm getting up to speed at the moment!)?
Ideally we would like to build an automated pipeline which publishes the latest documentation to Github pages :)
from create-openapi-repo.
I don't think you need this repository if you're using code annotations. The purpose of this repo is for those who hand-author their API definitions.
Check out https://github.com/redocly/redoc to build the docs from your annotation-generated API definitions.
from create-openapi-repo.
Thanks for the tip!
One of the 'nice to haves' is the ability to add supplementary documentation in Markdown. It seems this repo has some interesting tools to build/bundle multiple files into a single file. I'll take a look at https://github.com/redocly/redoc
from create-openapi-repo.
Related Issues (20)
- Replace interactive prompts with command line arguments HOT 1
- UnhandledPromiseRejectionWarning: TypeError: Cannot read property 'parameters' of undefined HOT 2
- UnhandledPromiseRejectionWarning: Unhandled promise rejection HOT 1
- Bug with generated windows file paths
- Redoc and create-openapi-repo versioning HOT 1
- Cannot read property 'responses' of undefined
- Deploy on Github Pages a full rendered HTML of ReDoc HOT 2
- Doesn't support Node 10 HOT 3
- Improve README
- create-openapi-repo --migrate-2-3 (spec/code_samples/ needs to be empty)
- Using Swagger Editor again
- No more .travis.yml
- No duplicate HTTP Requests Method
- [Question] Editor/plugin with support for embedding external markdown HOT 1
- Option to split files only where OpenAPI expect references? HOT 4
- twitch
- `$ref`s are generated with the backslashes on Windows
- Error message shows up: 'Every API should have security defined on the root level or for each operation' HOT 1
- sync-java project
- Update Readme
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from create-openapi-repo.