Coder Social home page Coder Social logo

Comments (3)

Odomontois avatar Odomontois commented on June 28, 2024 1

Hi.
Yeah, I have definitely heard about your awesome project and would gladly cooperate.

My project is about 1.5 year old. It was an internal Tinkoff bank project. I intented to publish it from the very start, but it is not so easy in the bank business.
I have published it without the history to hide sensitive informarion, so it misses previous 225 commits 😀

from typed-schema.

pheymann avatar pheymann commented on June 28, 2024

Hi @Odomontois ,
I realized you support swagger generation. There are also plans to add it to my lib but I haven't found a (satisfying) solution for the following problem:

How to add comments?

I mean, it is "simple" enough to generate the basic documentation from the type/value information available, but what I found crucial is to have comments. Otherwise, it is hard for people to really understand what is happening.

Did you find a way to incorporate comments into your (did see it so far but maybe I missed it) without cluttering the api declaration? I still haven't found a satisfying way.

from typed-schema.

Odomontois avatar Odomontois commented on June 28, 2024

Hi. Sorry for the late answer. Haven't been fully integrated OSS into my life
I have couple of distinct solutions here.
First are implicits with default arguments like here

https://github.com/TinkoffCreditSystems/typed-schema/blob/master/src/main/scala/ru/tinkoff/tschema/swagger/SwaggerTypeable.scala#L212

and here

https://github.com/TinkoffCreditSystems/typed-schema/blob/master/src/main/scala/ru/tinkoff/tschema/swagger/SwaggerTypeable.scala#L269

Second one, more like runtime one - injecting definitions from .properties bundles created like that https://github.com/TinkoffCreditSystems/typed-schema/blob/master/src/main/scala/ru/tinkoff/tschema/swagger/PathDescription.scala

Here the example of injecting https://github.com/TinkoffCreditSystems/typed-schema/blob/master/examples/src/main/scala/ru/tinkoff/tschema/examples/TestServer.scala#L22

And here is examples of .property file
https://github.com/TinkoffCreditSystems/typed-schema/tree/master/examples/src/main/resources

from typed-schema.

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.