0.0.2 • Published 2 years ago

tealina-gdoc v0.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

Generate API document from a specifice .d.ts file

Convietion

  1. The .d.ts only export one Interface
  2. The Interface should be a Record<string,{body:{..},response:{..},...}>

Entry Example

// entry.d.ts
export interface API_Record {
  '/user/create': {
    body: { name: string; age: number }
    response: {
      id: number
      name: string
      age: number
    }
  }
}
0.0.2

2 years ago

0.0.1

2 years ago

0.0.0

2 years ago