Coder Social home page Coder Social logo

Comments (5)

jgabriels avatar jgabriels commented on June 20, 2024 1

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.

RomanHotsiy avatar RomanHotsiy commented on June 20, 2024

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.

 avatar commented on June 20, 2024

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.

 avatar commented on June 20, 2024

@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.

RomanHotsiy avatar RomanHotsiy commented on June 20, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.