Switch branches/tags
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
docs
etc
src
LICENSE
README.md
application.log
config.yml
dependency-reduced-pom.xml
example.keystore
pom.xml

README.md

newsfeed-dropwizard

This Java project implements a rudimentary news feed micro-service using Swagger and DropWizard.

This article goes into detail about what was discovered while developing this micro-service.

http://glennengstrand.info/software/performance/clojure/dropwizard

newsfeed-swagger

The rest of these docs are swagger generated and cover how to call the micro-service.

See the docs/setup.md for tips on how to stand up the service.

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>info.glennengstrand</groupId>
    <artifactId>newsfeed-swagger</artifactId>
    <version>1.0.0-SNAPSHOT</version>
    <scope>compile</scope>
</dependency>

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/newsfeed-swagger-1.0.0-SNAPSHOT.jar
  • target/lib/*.jar

Documentation for API Endpoints

Class Method HTTP request Description
FriendApi addFriend POST /friends/new create a new friendship
FriendApi getFriend GET /friends/{id} retrieve the list of friends for an individual participant
InboundApi getInbound GET /inbound/{id} retrieve the inbound feed for an individual participant
OutboundApi addOutbound POST /outbound/new create a participant news item
OutboundApi getOutbound GET /outbound/{id} retrieve the news posted by an individual participant
OutboundApi searchOutbound POST /outbound/search create a participant news item
ParticipantApi addParticipant POST /participant/new create a new participant
ParticipantApi getParticipant GET /participant/{id} retrieve an individual participant

Documentation for Models