Swagger?

[dariofil-star]

Hi, any interest in implementing OpenAPI/Swagger?
https://swagger.io/specification/

[scottoffen]

Yes. Are you offering to do it?

[flyingbag]

Yes. I create a template that can be used by OpenAPI Generator. I'm reorganising the code and will be able to share in some days soon.

Here is a sample openapi.yaml:

openapi: '3.0.2'
info:
  title: Web App API
  version: '1.0.0'
servers:
  - url: http://localhost:8080/v1

paths:
  /web:
    get:
      tags:
        - Web App
      summary: Open a resource URL
      operationId: openUrl
      parameters:
        - name: url
          in: query
          required: true
          schema:
            type: string
          example: "https://example.com/"
      responses:
        '200':
          description: OK
    delete:
      tags:
        - Web App
      summary: Close the app
      operationId: close
      responses: 
        '204':
          description: No Content

Here are two versions of the generated code:

Version 1:

/*
 * Web App API
 *
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.0.0
 * Generated by: https://github.com/openapitools/openapi-generator.git
 */


using System.IO;
using System.Threading.Tasks;
using Grapevine;
using Newtonsoft.Json;
using WebApp.Api.Client;

namespace WebApp.Api.Api
{
    /// <summary>
    /// 
    /// </summary>
    [RestResource()]
    public class WebAppApi
    {
        /// <summary>
        /// Close the app
        /// </summary>
        [RestRoute("DELETE", "/Web", Name = "Close the app", Description = "")]
        public async Task Close(IHttpContext context)
        {
            // TODO: Implement your operation here.
            context.Response.StatusCode = HttpStatusCode.NoContent;
            await context.Response.SendResponseAsync();
        }
        /// <summary>
        /// Open a resource URL
        /// </summary>
        [RestRoute("GET", "/Web", Name = "Open a resource URL", Description = "")]
        public async Task OpenUrl(IHttpContext context)
        {
            // TODO: Implement your operation here.
            context.Response.StatusCode = HttpStatusCode.Ok;
            await context.Response.SendResponseAsync();
        }
    }
}

Version 2:

/*
 * Web App API
 *
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: 1.0.0
 * Generated by: https://github.com/openapitools/openapi-generator.git
 */


using System.IO;
using System.Threading.Tasks;
using Grapevine;
using Newtonsoft.Json;
using WebApp.Api.Client;

namespace WebApp.Api.Api
{
    /// <summary>
    /// 
    /// </summary>
    [RestResource()]
    public abstract class WebAppApi
    {
        /// <summary>
        /// Close the app
        /// </summary>
        [RestRoute("DELETE", "/Web", Name = "Close the app", Description = "")]
        public abstract Task Close(IHttpContext context);
        /// <summary>
        /// Open a resource URL
        /// </summary>
        [RestRoute("GET", "/Web", Name = "Open a resource URL", Description = "")]
        public abstract Task OpenUrl(IHttpContext context);
    }
}

I intended to create an inherited class from a separate assembly, then I realized version 2 in this case won't work because AttributeTargets.Assembly was missing to RestResourceAttribute (also to ResourceLifetimeAttribute).

Let me know what you think. I will be able to create a pull request soon to make the two attributes to target both AttributeTargets.Assembly | AttributeTargets.Class.

---

(edited)
This approach won't work either. Would need your advices.

Cheers
Gao Yang

[flyingbag]

Created a PR that updates attribute inheritance check in RouteScanner. The updated Grapeseed can work with version 2 of the generated code.

For demonstration/verification follow below steps:

1. Apply this 6df5c1.patch on the main branch
2. Run the Samples project and query the API using Postman.
   • The Postman script is here: src/Samples.OpenAPI/WebApp/postman.json.

Screenshot: