Giter VIP home page Giter VIP logo

springfox-protobuf's Introduction

Springfox Protobuf Support

This module aims to add usable support to sue protobuf messages in springfox. It provides a jackson module that can be registered in SpringFox's ObjectMapper.

The provided module does not handle the actual (de-)serialization of messages. Use e.g. the jackson-datatype-protobuf module for that functionality.

Setup

Add this module and jackson-datatype-protobuf to your dependencies.

Configure SpringFox's ObjectMapper. Also specify that your endpoints can produce json (either via e.g. @GetMapping(produces="application/json") or via your Docket).

@Configuration
@EnableSwagger2
public class SpringFoxConfiguration implements ApplicationListener<ObjectMapperConfigured> {
	/** Configure SpringFox's internal ObjectMapper. */
	@Override
	public void onApplicationEvent(ObjectMapperConfigured event) {
		event.getObjectMapper().registerModule(new ProtobufModule());
		event.getObjectMapper().registerModule(new ProtobufPropertiesModule());
	}
	
	/** Set up Docket for endpoints that produce protobuf. */
	@Bean
	public Docket myDocket() {
		return new Docket(DocumentationType.SWAGGER_2)
			// your normal configuration
			.produces(new HashSet<>(Arrays.asList("application/json", "application/x-protobuf")));
	}
}

Usage

Open up springfox as usual. Protobuf endpoints should show up with their properties and be usable. Make sure to select application/json in the dropdown to get the human readable representation.

springfox-protobuf's People

Contributors

xehonk avatar daltonfury42 avatar dependabot[bot] avatar

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.