Giters

mandarineorg / mandarinets

Mandarine.TS is a typescript, decorator-driven framework that allows you to create server-side applications. Mandarine.TS provides a range of built-in solutions such as Dependency Injection, Components, ORM and more. Under its umbrella, Mandarine.TS has 4 modules: Core, Data, Security and MVC, these modules will offer you the requirements to build a Mandarine-powered application.

Home Page:https://www.mandarinets.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Any plan to support OpenAPI

linux-china opened this issue · comments

commented

Now Mandarinets has annotations for HTTP routing, and any plan to add OpenAPI related annotations to generate OpenAPI json? It will be friendly for OpenAPI related tools, such as Swagger-UI, OpenAPI client tools etc. Now I can not find Deno framework to support OpenAPI.

commented

I'll have to look into it, seems like a nice feature to have. I'll be investigating how we could or could not make this possible.

commented

I created a demo to show how to use OpenAPI annotations in Mandarine, and the url is https://github.com/linux-china/mandarine-demo

commented

@linux-china what would be the benefit of using such annotations ? Just general metadata for the application and the developer? Documentation ? Which I guess could work for generating specs or administrative/technical documents with a technical summary of what the API of your site looks like (?)

commented

yes, These annotations help to generate OpenAPI metadata json for the application, otherwise you should write OpenAPI json by hand. The OpenAPI metadata json is useful for GUI display as document and language SDK generation to call HTTP REST API.

commented

I like it. Let's land it in 2.4.0