swagger-api / swagger-core

Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
http://swagger.io
Apache License 2.0
7.39k stars 2.19k forks source link

Extending @Api #1969

Open archenroot opened 8 years ago

archenroot commented 8 years ago

We would like to store info about underlying table name and column, in general about persistence layer in swagger. Can someone suggest the best way of doing this? Is it even the good way from your experience?

In general I can do it in 2 ways as I see it:

public interface ApiModelPropertyExtended extends ApiModelProperty{} or by not breaking existing consumers of this interface by going with default void where I include directly the implementation -> required Should this be hidden or publicly visible information, I am not sure about it.

Any suggestions welcomed.

webron commented 8 years ago

If you want to include such information, it sounds like it should be in description.

Design-wise, in most cases it doesn't make sense to expose this information unless you write an API to a database and not an application.

archenroot commented 8 years ago

We migrate huge Oracle Plsql code managing 1-3000 tables into microservices architecture. We have of course entities, mappers config files, but for technical source code checks, we would like to see this info on DTO level. Sometimes DTO maps to multiple entities and such info could be handy. It is not ment to be exposed to the public clients.

sent from mobile, Ladislav

On 18 Oct 2016 7:45 p.m., "Ron" notifications@github.com wrote:

If you want to include such information, it sounds like it should be in description.

Design-wise, in most cases it doesn't make sense to expose this information unless you write an API to a database and not an application.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/swagger-api/swagger-core/issues/1969#issuecomment-254584346, or mute the thread https://github.com/notifications/unsubscribe-auth/AAhyKM3wdbd6cyqdT_oD9SbPVdMa7wKBks5q1QWsgaJpZM4KZy5G .

fehguy commented 8 years ago

@archenroot sounds like a bigger conversation. If you'd like to talk about this, please send a note to apiteam@swagger.io and we can discuss.