It does not work in Golang source code

[ahmedxfn]

Isn't this tool should work on any language (agnostic) ? when tried it on Golang, it returns nothing.

Example:

/*
 * @api [get] /pet/{petId}
 * description: "Returns all pets from the system that the user has access to"
 * parameters:
 *   - (path) petId=2* {Integer} The pet ID
 *   - (query) limit {Integer:int32} The number of resources to return
 * responses:
 *   200:
 *     description: It works!
 */
func pet() {}

[jesseyowell]

Hi there,

I think the syntax is a bit off, and this probably belongs under https://github.com/readmeio/swagger-inline/issues but I'll see if I can help.

1. Comment should start with @oas:

/*
 * @oas [get] /pet/{petId}
 * description: "Returns all pets from the system that the user has access to"
 * parameters:
 *   - (path) petId=2* {Integer} The pet ID
 *   - (query) limit {Integer:int32} The number of resources to return
 * responses:
 *   200:
 *     description: It works!
 */
func pet() {}

How are you runnning the swagger-inline package? Should be similar to:

npx swagger-inline "./*.go" --base 'file.json' > api.json

[ahmedxfn]

Since oas depends on swagger-inline and the latter depends on comment-patterns, It turns out the issue is in the comment-patterns lib, it only reads the single line comment pattern in Golang as you can see here https://github.com/nknapp/comment-patterns/blob/master/languages/patterns/go.js.
Therefore there are two solutions either:

1. Update comment-patterns to support muli-line comment pattern by adding multiLineComment: require('./common/c-style.js').multiLine() to /languages/patterns/go.js file.
2. Switch to single line comment.

[ahmedxfn]

A new release is pushed to comment-patterns, Go multi-line comment is now supported.