Ben TypeScipt yazılmış bir projenin parçası ve ben Swagger ile uyumlu olacak typescript Web Sunucusu eklemek çalışıyorum bir dayı web hizmeti oluşturmak için uygun yolu budur. Kolay korunabilirliğe dikkate bunu uygulamaya en temel strateji nedir
.typescript
Typescript için TipScript Arabirimi'nden bir JSON Modeli oluşturmak için 'Typson' kitaplığı olduğunu fark ettim. o Fiyakamla için JSON modeller ekleyerek destekler beri Swagger için
- , ben, 'dayı-düğüm-restify' kitaplığı kullanarak çalıştılar.
Ancak, bazı sorunlarla karşılaşabilirsiniz:
-
Typson İthalat ait typescript
sözdizimi desteklemiyor
- - Ben swagger-düğüm-restify uygulamaya çalışmıştır (
import {Server} from "restify"
) - 'örnek (Pet Örnek) Ancak localhost tEPKİ: 8080/API-docs.json GET isteği API tüm SPEC verileri eksik.
{"apiVersion":"0.1","swaggerVersion":"1.1","basePath":"http://localhost:8080","apis":[{"path":"/api-docs.{format}/pet","description":"none"}]}
Bu en iyi yaklaşımdır. Birçok proje, kod -> swagger'dan hizmet oluşturma çabası içindedir, ancak bunun en iyi yaklaşım olmadığını düşünüyorum. JSON'da (Json şemasının entegrasyonu nedeniyle YAML'den daha standart olan) daha hızlı bir özellik yazarak API'nizin belgelerini belirli bir çalışma zamanı ortamına veya uygulamasına bağlıyorsunuz. Bunun yerine, bir spreye yazıyorsunuz ve daha sonra swagger-codegen'i kullanarak o speklerden istemcileri veya sunucuları oluşturuyorsunuz. – coding