Git Product home page Git Product logo

Comments (3)

deepmap-marcinr avatar deepmap-marcinr commented on May 22, 2024

There are many cases where this will happen, so I'm thinking of side-stepping the problem by allowing people to specify the Go variable name explicitly via extended properties. You could do something like:

/animal/{type}:
    get:
      summary: Get an animal by type
      parameters:
        - name: type
          x-golang-name: animalType
          in: path
          required: true
          schema:
            type: string

which would yield

type ServerInterface interface {
  GetAnimalByType(ctx echo.Context, animalType string, params GetAnimalByTypeParams) error
}

I'm in the middle of a big project right now, but I'll revisit this sometime soon.

from oapi-codegen.

stevenvegt avatar stevenvegt commented on May 22, 2024

The problem here is that you do not always have control over the spec as it can be created by a third party. Adding language specific tags sounds like a hack.

Postfixing every param with Param for example would also result in an unique non-confilicting string.

If we can think up an elegant solution I'm happy to provide a PR if that helps you.

from oapi-codegen.

deepmap-marcinr avatar deepmap-marcinr commented on May 22, 2024

You're right.

I didn't want to break existing clients, so in the case of parameters which are go keywords, I prefix those with p, so type becomes pType. Non-conflicting names are not prefixed.

from oapi-codegen.

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.