typescript-rest-swagger icon indicating copy to clipboard operation
typescript-rest-swagger copied to clipboard

How to set the summary?

Open Shamshiel opened this issue 4 years ago • 1 comments

I'm unsure what I need to write to set the summary of a method.

@Accept('text/plain')
@Path('mypath')
export class MyService {
    /**
     * This description will be used to describe the get operation of path '/mypath' on the generated swagger
     * @param test And this will describe the parameter test of this same operation
     */
    @GET
    @Path('secondpath')
    test2( @QueryParam('testParam')test?: string ): Person {
        return {name: 'OK'};
    }
}

This sets the "description" property of the swagger.json. How to set the summary property?

Shamshiel avatar May 29 '20 11:05 Shamshiel

/**

  • @summary blahblah */

wisedog avatar Aug 10 '20 04:08 wisedog