UNPKG

@loopback/openapi-v3

Version:

Decorators that annotate LoopBack artifacts with OpenAPI v3 metadata and utilities that transform LoopBack metadata to OpenAPI v3 specifications

loopbackio/loopback-next

56 lines (55 loc) • 2.23 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
import { OperationObject } from '../types'; /** * Expose a Controller method as a REST API operation * mapped to `GET` request method. * * @param path - The URL path of this operation, e.g. `/product/{id}` * @param spec - The OpenAPI specification describing parameters and responses * of this operation. */ export declare function get(path: string, spec?: OperationObject): MethodDecorator; /** * Expose a Controller method as a REST API operation * mapped to `POST` request method. * * @param path - The URL path of this operation, e.g. `/product/{id}` * @param spec - The OpenAPI specification describing parameters and responses * of this operation. */ export declare function post(path: string, spec?: OperationObject): MethodDecorator; /** * Expose a Controller method as a REST API operation * mapped to `PUT` request method. * * @param path - The URL path of this operation, e.g. `/product/{id}` * @param spec - The OpenAPI specification describing parameters and responses * of this operation. */ export declare function put(path: string, spec?: OperationObject): MethodDecorator; /** * Expose a Controller method as a REST API operation * mapped to `PATCH` request method. * * @param path - The URL path of this operation, e.g. `/product/{id}` * @param spec - The OpenAPI specification describing parameters and responses * of this operation. */ export declare function patch(path: string, spec?: OperationObject): MethodDecorator; /** * Expose a Controller method as a REST API operation * mapped to `DELETE` request method. * * @param path - The URL path of this operation, e.g. `/product/{id}` * @param spec - The OpenAPI specification describing parameters and responses * of this operation. */ export declare function del(path: string, spec?: OperationObject): MethodDecorator; /** * Expose a Controller method as a REST API operation. * * @param verb - HTTP verb, e.g. `GET` or `POST`. * @param path - The URL path of this operation, e.g. `/product/{id}` * @param spec - The OpenAPI specification describing parameters and responses * of this operation. */ export declare function operation(verb: string, path: string, spec?: OperationObject): MethodDecorator;