Comments (5)
I have a fully working code generator:
https://github.com/Direct-Freight/df-api-docs/blob/master/scripts/generate-code-samples.js
It's called during the build:
https://github.com/Direct-Freight/df-api-docs/blob/master/scripts/build.js
You can see what the final results looks like here:
http://apidocs.directfreight.com/#tag/boards
I created a pull request here: #18
but haven't tested it on any third party definitions.
from create-openapi-repo.
Hey @DataTigerGitHub,
There is no feature to automatically generate code samples right now.
Adding code samples to spec
steps adds samples from spec/code_samples
folder in your repo.
Just add them according to the README file in this folder.
Use sample repo for the reference.
As for Running plugins
message, it is not related to code samples thing and it's ok.
from create-openapi-repo.
Thanks @RomanGotsiy
If someone else is looking, I am making good progress with https://github.com/ErikWittern/swagger-snippet for the snippet generation. Manual generation works will out of postman http://blog.getpostman.com/2015/08/31/writing-front-end-api-code-with-postman/
from create-openapi-repo.
@RomanGotsiy
One more question which should solve my issue. I have now generated most of my code snippets. But how do I reference them properly. I looked at the sample repo, but can't figure it out as they are ordered by post and get and not by the method name.
When I look at the sample files, I can only find examples which have the code inside the yaml, like the following. An example which reads the snippets from the files would be great.
Thanks!
x-code-samples:
- lang: 'C#'
source: |
PetStore.v1.Pet pet = new PetStore.v1.Pet();
pet.setApiKey("your api key");
pet.petType = PetStore.v1.Pet.TYPE_DOG;
pet.name = "Rex";
// set other fields
PetStoreResponse response = pet.create();
if (response.statusCode == HttpStatusCode.Created)
{
// Successfully created
}
else
{
// Something wrong -- check response for errors
Console.WriteLine(response.getRawResponse());
}
from create-openapi-repo.
IF you use generator-openapi-repo then you just have to put your snippets into correct folders:
<lang>/<path>/<HTTP verb>.<extension>
where <path>
is the method path.
To bundle your snippets into single spec just run: npm run build
and you will get your bundled file in web_deploy/swagger.json
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.