Swagger support? about pistache

[sebymiano]

I added the support for Pistache on swagger-codegen.
It generates a server stub using Pistache as C++ server library and Json for Modern C++ for JSON serialization/deserialization.

An example of the automatically generated code can be found here.

[cyremur]

Yes, you have to build with rapidJSON installed.

Try the rest description example. There is a hard coded path to oktal's swagger installation. If you replace that with your local swagger distribution, the example builds a banking API stub and serves an API json and a swagger doc page.

[jwmonaco]

I had two issues with this codegen support:

1. The library name changed from Net to Pistache, so the generated code will not compile. This issue was already mentioned in 6278d88

2. The simple swagger example below generates code that will not compile. I don't see any errors/warning coming from codegen.

swagger: '2.0'
info:
  version: "1.0"
  title: Testing
definitions:
  versionInfo:
    type: object
    properties:
      timestamp:
        type: string
paths:
  /version:
    get:
      operationId: versionInfo
      responses:
        200:
          description: OK
          schema:
            $ref: '#definitions/versionInfo'

The problem is the the generated code has an include of the form #include "#definitions/versionInfo.h". It should be #include "VersionInfo.h". Here's the commands I used after saving the above snippet as /tmp/tst.yml. Examine /tmp/swagger/DefaultApi.h to see the bad include.

sudo docker run -v /tmp:/tmp swaggerapi/swagger-codegen-cli generate -l pistache-server -o /tmp/swagger -i /tmp/tst.yml
[main] INFO io.swagger.parser.Swagger20Parser - reading from /tmp/tst.yml
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/model/VersionInfo.h
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/model/VersionInfo.cpp
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/api/DefaultApi.cpp
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/DefaultApiMainServer.cpp
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/api/DefaultApi.h
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/impl/DefaultApiImpl.cpp
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/impl/DefaultApiImpl.h
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/model/ModelBase.h
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/model/ModelBase.cpp
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/CMakeLists.txt
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/README.md
[main] INFO io.swagger.codegen.AbstractGenerator - writing file /tmp/swagger/.swagger-codegen/VERSION

[sebymiano]

@jwmonaco you missed a / in the $ref.
The right version is $ref: '#/definitions/versionInfo' instead of $ref: '#definitions/versionInfo'.
If you run swagger-codegen with this updated yaml file it works as expected.

Regarding the first issue, I have updated codegen with the new library name. I'll submit a PR soon.

[jwmonaco]

D'oh. Thanks! Out of curiosity did you see that mistake by inspection or did you use a tool to validate the example? I thought it was OK since I didn't get any errors from code gen or editor saying my reference was bad. Seems like a tool should have pointed me towards my mistake.

[sebymiano]

@jwmonaco you're welcome :)
I didn't use any tool to validate it. Btw, the example you provided is compliant with the swagger syntax.

The $ref: '#definitions/versionInfo' is still a valid path but it doesn't reference the versionInfo object available under definitions since the full path should start with the /.

[FranciscoGualdi]

Hello all... I truing to get more info about the pistache description.
Is it generated the OAS specification based on the pistache endpoint?
Is it possible request the specification using the pistache endpoint? How should be the request?

Any information will be great!

[dennisjenkins75]

Examine "examples/rest_description.cc"

In one terminal:

$ ./build/examples/run_rest_description 9999
Cores = 4
Using 2 threads

In other terminal:

$ curl -s http://localhost:9999/banker-api.json | head 
{
    "swagger": "2.0",
    "info": {
        "title": "Banking API",
        "version": "0.1"
    },
    "basePath": "/v1",
    "schemes": [
        "http"
    ],