2016-03-07 6 views
7

Jestem częścią projektu napisanego w TypeScipt i próbuję dodać serwer WWW TypeScript, który będzie kompatybilny z Swagger.
Jaka jest najbardziej podstawowa strategia wdrożenia, biorąc pod uwagę łatwą konserwację.jaki jest właściwy sposób tworzenia usługi WWW typu łobuz w TypeScript

  • Na maszynie mam informuje, że istnieje biblioteka „Typson” do generowania JSON model z maszynopis Interface.

  • Dla Swaggera, próbowałem używać biblioteki 'restrykcyjne-węzły-restify', ponieważ obsługuje ona dodawanie modeli JSON do przechwałek.

Mam jednak pewne problemy:

  1. Typson nie obsługuje maszynopis składni importu - (import {Server} from "restify")
  2. starałem się wdrożyć „Swagger-node-restify "przykład (przykład dla zwierząt), jednak RESPONSE localhost: 8080/api-docs.json GET Request nie zawiera wszystkich danych SPEC interfejsu API. {"apiVersion":"0.1","swaggerVersion":"1.1","basePath":"http://localhost:8080","apis":[{"path":"/api-docs.{format}/pet","description":"none"}]}

Odpowiedz

3

Proponuję opisać API zgodnego Swagger użyciu yaml lub json i wygenerować serwer z tego.

swagger-server może budować interfejsy API w oparciu o express w czasie rzeczywistym (bez generowania kodu źródłowego).

Istnieje JavaScript kod generatory:

  • połączeń klient swagger-Codegen z -l nodejs-server

  • swagger-node jest doskonałą alternatywą, ale wydaje się trudne do zintegrowania z TypeScript

+0

To najlepsze podejście. Wiele projektów dokłada starań, aby budować usługi z kodu -> chichocząc, ale uważam, że to nie jest najlepsze podejście. Pisząc specyfikację SWAGER w JSON (który jest bardziej standardowy niż YAML ze względu na integrację Json-schema), nie wiążesz dokumentacji API z określonym środowiskiem uruchomieniowym lub implementacją. Zamiast tego piszesz do specyfikacji, a następnie budujesz klientów lub serwery z tej specyfikacji, używając kodera-sprzedawcy. – coding

Powiązane problemy