tsoa-next / tsoa-next
نشأة المشروع
tsoa-next استمر tsoa مشروع The original repository and its contributors established the stable TypeScriptأولاً OpenAPI-الأساس الأول لهذا العمل يعتمد عليه Where historical release notes or migration references still point upstream, they are kept intentionally for provenance.
الهدف
- TypeScript المتحكمون والنماذج كمصدر واحد للحقيقة
- A valid OpenAPI (سابقا) Swagger20, 3.0, or 3.1 spec is generated from your controllers and models, including:
- الرياضيات (مثل GET /users)
- التعاريف القائمة على أساس TypeScript الوصلات البينية (العارضات)
- البارامترات/الممتلكات النموذجية المميزة حسب الاقتضاء أو الاختيارية على أساس TypeScript (على سبيل المثال، بلدي Property)؟ الخيط اختياري في OpenAPI العينة
- jsDoc supported for object descriptions (most other metadata can be inferred from TypeScript الأنواع
- تولد الدروب للخيارات المتوسطة
- Express.. Hapiو Koa ويمكن حالياً دعم الإطارات الوسيطة الأخرى باستخدام نموذج معالج بسيط
- الحمولات المقيدة
الفلسفة
- إعادة تشغيل TypeScript نوع الشروح لتوليد البيانات الفوقية للبروتوكول الاختياري إذا أمكن
- إذا كانت الشروح من النوع العادي ليست طريقة مناسبة للتعبير عن البيانات الفوقية، استخدام المصممين
- Use jsdoc for pure text metadata (e.g. endpoint descriptions)
- الحد الأدنى من الغليان
- النماذج هي أفضل طريقة لتمثيلها بالوصلات البينية (هيكل البيانات المشروطة)، ولكن يمكن أيضاً تمثيلها بالصفوف
- التحقق من وقت العمل tsoa-next ينبغي أن تتصرف بأكبر قدر ممكن من الدقة في المواصفات التي تولدت OpenAPI الكيماوي يصف وتوضح أي اختلافات في منطق التصديق بتحذيرات قطع الأشجار أثناء توليد OpenAPI المواصفات و/أو الطرق.
- يرجى ملاحظة ذلك بتمكينها من ذلك OpenAPI 3-0 أو 3-1 تُقلّل إلى أدنى حدّ من فرص المنطق المتباين في التحقّق بما أنّ الأشكال الكيميائيّة الجديدة أكثر تعبيراً من OpenAPI 2.0
قائمة الميزات
- الجيل OpenAPI 2.0, 3.0, أو 3.1 وثائق مباشرة من TypeScript المتحكمون، النماذج، JSDoc تعليقات.
- Treat TypeScript المتحكمون والنماذج كمصدر للحقيقة للمسارات والبارامترات والكساءات والأمثلة والعلامات والبيانات الوصفية الأمنية.
- ناقلات طرق محددة لإطار عمل Express.. Koaو Hapiأو إمدادك بنفسك Handlebars نماذج للزمن المعتاد
- (ب) تقديم مدخلات قيمة في الوقت الحاضر مع إكراه قابل للتشكيل ومناولة إضافية للأفضلية تظل متوافقة مع الكيميائي المولد.
- المواصفات النهائية للمراقبين المحليين
@SpecPath(...)بدون قراءة ملف مطوّر من قرص محلي عند الطلب - الخدم المبنية
json..yaml..swagger..redocوrapidocالمواصفات، مع دقّات docs UI محملة بشكل سلس كقران اختياريين عند توافرها. - Attach multiple
@SpecPath(...)المصممون لنفس المتحكم طالما أن طرقهم المصممة فريدة - Cache built in or custom spec responses with
'none'داخل العملية'memory'أو مُعالج مُحتال يُمكن أن يقرأ من الخيوط أو المجرى - العودة إما
stringأوReadableالردود الواردة من العرف@SpecPath(...)من يتعاملون مع الوثائق الجاهزة أو عمليات التكامل في المراحل النهائية. - الاستخدام
@Validate(...):: تفويض المصادقة على الوقت المحدد لمكتبات الكيماويات الخارجية المدعومة مثلzod..joi..yup..superstructأوio-ts. - إضفاء الطابع العرفي على ترجمة المصادقة وشكل الفشل من خلال سياق التصديق الاختياري الذي تم قبوله من خلال توليد
RegisterRoutes(...)الوظائف - دعم التوثيق، حقنة التبعية، المستجيبين المناوبين المطبوعين، حمولات الملفات، البرمجيات المتوسطة العرفية، تدفقات عمل التثبيت
- استخدام
tsoaCLI للمواصفات وتوليد الطرق، أو تسمية مؤشرات الأداء البرنامجية منtsoa-next/cli. - الهدف الحديث Node.js الإطلاقات المصحوبة بسياسة الدعم التي تم التحقق منها في مركز التحقيقات الجنائية عبر النظام التجاري الدولي السابق، وهو النظام الحالي للمواصلات السلكية واللاسلكية، Node vNext.
البدء
- الاحتياجات:
- Node.js 22 أو جديد
- npm 10 أو أكثر
- نحن نتحقق من الدعم في جميع أنحاء LTS السابقة، و LTS الحالية، و Node vNext in CI
- الوثائق
- مرجع API
- دليل البدء
واجهة الحزمة
- مدخرات للواردات، ومساعدات لمدد زمنية محددة، وولدت الدعم من الطرق
tsoa-next - برامجيات الاستيراد
tsoa-next/cli - استخدام
tsoaثنائية CLI أوامر الجيل
أمثلة
اطّلع على الأدلة
استخدم مستودع playground المرافق للحصول على تطبيقات أمثلة قابلة للتشغيل وسيناريوهات تركّز على الخادم.
اطّلع على أمثلة المتحكمات في الاختبارات
اطّلع على أمثلة النماذج في الاختبارات
نحتاج إلى المساعدة
المساهمة في الكود
للمساهمة (عبر طلب سحب PR)، يرجى الاطلاع أولاً على دليل المساهمة
أماكن الاسم
Classes
- Controller
- ExpressTemplateService
- HapiTemplateService
- KoaTemplateService
- TemplateService
- ValidateError
- ValidationService
الجوانب
- AdditionalProps
- ArrayValidator
- BooleanValidator
- Config
- DateTimeValidator
- DateValidator
- EmbeddedSpecGeneratorArtifacts
- Exception
- FieldErrors
- File
- FloatValidator
- IntegerValidator
- IocContainer
- ParameterValidationMetadata
- ResolvedSpecResponse
- RoutesConfig
- RuntimeSchemaAdapter
- RuntimeSpecConfigSnapshot
- SpecCacheContext
- SpecCacheHandler
- SpecConfig
- SpecGenerator
- SpecPathDefinition
- SpecPathOptions
- SpecRequestContext
- StringValidator
نوع الياز
- BuiltinSpecPathTarget
DeprecatedOptionForAdditionalPropertiesHandling- ExtensionType
- HttpStatusCodeLiteral
- HttpStatusCodeStringLiteral
- IocContainerFactory
- Newable
- OtherValidOpenApiHttpStatusCode
- RuntimeSchemaAdapterResult
- ServedSpec
- ServiceIdentifier
- SpecDocumentFormat
- SpecPathCache
- SpecPathGate
- SpecPathGateHandler
- SpecPathTarget
- SpecResponseHandler
- SpecResponseValue
- SpecRuntime
- TsoaResponse
- Validator
الوظائف
- assertNever
- Body
- BodyProp
- Consumes
- createEmbeddedSpecGenerator
- createOpenApiSpecGenerator
- Delete
- Deprecated
- describeSpecPath
- Example
- Extension
- fetchMiddlewares
- fetchSpecPaths
- FormField
- Get
- getParameterExternalValidatorMetadata
- Head
- Header
- Hidden
- Inject
- isDefaultForAdditionalPropertiesAllowed
- Middlewares
- normalisePath
- NoSecurity
- OperationId
- Options
- Patch
- Path
- Post
- Produces
- Put
- Queries
- Query
- Request
- RequestProp
- Res
- resolveSpecPathResponse
- Response
- Route
- Security
- SpecPath
- SuccessResponse
- Tags
- UploadedFile
- UploadedFiles
- Validate
- validateExternalSchema
- ValidateParam
Contributors
No contributors
Changelog
No recent changes