GithubHelp home page GithubHelp logo

mitallast / openapi2proto Goto Github PK

View Code? Open in Web Editor NEW
3.0 3.0 1.0 306 KB

Protobuf v3 with gRPC generator from subset of openapi v3

License: MIT License

Scala 71.99% Shell 10.98% HTML 16.62% Java 0.41%
graalvm grpc-generator openapi protobuf scala

openapi2proto's People

Contributors

mitallast avatar

Stargazers

avatar avatar avatar

Watchers

avatar avatar avatar avatar

Forkers

zored

openapi2proto's Issues

Feature: Support custom options for fields

We need to mark a field of golang structure with a custom tag.
Gogo supports it using the moretags custom option.
I propose to support custom options for fields using the following design:

openapi: 3.0.1
x-proto-package: mypackage
x-proto-import:
  - "github.com/gogo/protobuf/gogoproto/gogo.proto"
info:
  title: User
  version: 1.0.0
paths: {}
components:
  schemas:
    User:
      type: object
      required:
        - name
        - password
      properties:
        name:
          type: string
        password:
          x-proto-option:
            "gogoproto.moretags": 'sensitive:"true"'
          type: string

Openapi2proto must generate the following proto file:

syntax = "proto3";

package mypackage;

import "google/api/annotations.proto";
import "google/protobuf/wrappers.proto";
import "google/protobuf/timestamp.proto";
import "github.com/gogo/protobuf/gogoproto/gogo.proto";

message User {
   string name = 1;
   string password = 2 [(gogoproto.moretags) = 'sensitive:"true"'];
}

Custom options may be attached to a field of any type. The number of options is more or equal to zero.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.