backend icon indicating copy to clipboard operation
backend copied to clipboard

Docs/swagger documentation

Open DevJoaoPeu opened this issue 1 year ago • 3 comments

Criei uma pasta swagger para exporta dela todas as configs do swagger, para deixar o código um pouco mais organizado, criei o dto da /users e da /supply-categories, também usei a função MakeSwagger para passar o conteúdo dá doc. Casso esse PR seja aceito, crio o dto para o restante das rotas e documento elas, caso queira que eu faça alguma alteração, pode entrar em contato comigo via linkedin: https://www.linkedin.com/in/joao-pedro-pereira-/

DevJoaoPeu avatar May 13 '24 01:05 DevJoaoPeu

Como já está sendo usado o nest, faz mais sentido usar o proprio swagger dele para isto.

LeoFC97 avatar May 13 '24 02:05 LeoFC97

Eu utilizei o swagger, só importei a função fora dele para não precisar importar um monte de decorador no controller, mas vocês preferem que eu faça como? Me fale que altero meu PR, Eu realmente quero ajudar!

Em dom., 12 de mai. de 2024 23:19, Leonardo Costa @.***> escreveu:

Como já está sendo usado o nest, faz mais sentido usar o proprio swagger dele para isto.

— Reply to this email directly, view it on GitHub https://github.com/SOS-RS/backend/pull/88#issuecomment-2106517209, or unsubscribe https://github.com/notifications/unsubscribe-auth/A2PDDJVUBH2LIRU5LU5BARLZCAPMPAVCNFSM6AAAAABHTIWNJWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMBWGUYTOMRQHE . You are receiving this because you authored the thread.Message ID: @.***>

DevJoaoPeu avatar May 13 '24 02:05 DevJoaoPeu

Eu utilizei o swagger, só importei a função fora dele para não precisar importar um monte de decorador no controller, mas vocês preferem que eu faça como? Me fale que altero meu PR, Eu realmente quero ajudar! Em dom., 12 de mai. de 2024 23:19, Leonardo Costa @.> escreveu: Como já está sendo usado o nest, faz mais sentido usar o proprio swagger dele para isto. — Reply to this email directly, view it on GitHub <#88 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/A2PDDJVUBH2LIRU5LU5BARLZCAPMPAVCNFSM6AAAAABHTIWNJWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMBWGUYTOMRQHE . You are receiving this because you authored the thread.Message ID: @.>

Isso não pode causa um problema para atualizar a lib no futuro ? Ou então em caso de usar decorator do nest/swagger como tag ou outros ficar uma mistura de decorator personalizados (MakeSwagger) e do nest/swagger causando confusão! Essa abstração é mesmo necessária ?

glauberborges avatar May 13 '24 14:05 glauberborges

Ok, vou refazer meu pr!

DevJoaoPeu avatar May 13 '24 17:05 DevJoaoPeu