Current implementations of the Dropwizard and JDK.
This API is based on the web-api-skeleton. For more documentation on the skeleton and the framework, see the github repo: https://github.com/osu-mist/web-api-skeleton
HTTPS is required for Web APIs in development and production. Use keytool(1) to generate public and private keys.
Generate key pair and keystore:
$ keytool \
-genkeypair \
-dname "CN=Jane Doe, OU=Enterprise Computing Services, O=Oregon State University, L=Corvallis, S=Oregon, C=US" \
-ext "san=dns:localhost,ip:127.0.0.1" \
-alias doej \
-keyalg RSA \
-keysize 2048 \
-sigalg SHA256withRSA \
-validity 365 \
-keystore doej.keystore
Export certificate to file:
$ keytool \
-exportcert \
-rfc \
-alias "doej" \
-keystore doej.keystore \
-file doej.pem
Import certificate into truststore:
$ keytool \
-importcert \
-alias "doej" \
-file doej.pem \
-keystore doej.truststore
This project uses the build automation tool Gradle. Use the Gradle Wrapper to download and install it automatically:
$ ./gradlew
The Gradle wrapper installs Gradle in the directory ~/.gradle. To add it to your $PATH, add the following line to ~/.bashrc:
$ export PATH=$PATH:/home/user/.gradle/wrapper/dists/gradle-2.4-all/WRAPPER_GENERATED_HASH/gradle-2.4/bin
The changes will take effect once you restart the terminal or source ~/.bashrc.
List all tasks runnable from root project:
$ gradle tasks
Generate IntelliJ IDEA project:
$ gradle idea
Open with File -> Open Project.
Copy configuration-example.yaml to configuration.yaml. Modify as necessary, being careful to avoid committing sensitive data.
Please refer to Location API for locations session configuration
Build the project:
$ gradle build
JARs will be saved into the directory build/libs/.
Run the project:
$ gradle run
Any code that contains intellectual property from a vendor should be stored in Github Enterprise instead of public Github. Make the name of the contrib repo in Github Enterprise follow this format using archivesBaseName in gradle.properties.
archivesBaseName-contrib
Set the value of getContribFiles to yes in gradle.properties.
getContribFiles=yes
Also set the value of contribCommit to the SHA1 of the desired commit to be used from the contrib repository.
contribCommit={SHA1}
Files in a Github Enterprise repo will be copied to this directory upon building the application.
gradle build
Contrib files are copied to:
/src/main/groovy/edu/oregonstate/mist/contrib/
Clone the skeleton:
$ git clone --origin skeleton git@github.com:osu-mist/web-api-skeleton.git my-api
$ cd my-api
Rename the webapiskeleton package and SkeletonApplication class:
$ git mv src/main/groovy/edu/oregonstate/mist/webapiskeleton src/main/groovy/edu/oregonstate/mist/myapi
$ vim src/main/groovy/edu/oregonstate/mist/myapi/SkeletonApplication.class
Update gradle.properties with your package name and main class.
Replace swagger.yaml with your own API specification.
Update configuration-example.yaml as appropriate for your application.
Update the resource examples at the end of this readme.
Add the skeleton as a remote:
$ git remote add skeleton git@github.com:osu-mist/web-api-skeleton.git
$ git fetch skeleton
Merge the skeleton into your codebase:
$ git checkout feature/abc-123-branch
$ git merge skeleton/master
...
$ git commit -v
Fetch updates from the skeleton:
$ git fetch skeleton
Merge the updates into your codebase as before. Note that changes to CodeNarc configuration may introduce build failures.
$ git checkout feature/abc-124-branch
$ git merge skeleton/master
...
$ git commit -v
The Web API definition is contained in the Swagger specification.
This resource returns all dining information and generates locations-dining.json for elasticsearch.
$ curl https://localhost:8080/api/v0/locations/dining --cacert doej.pem --user "username:password"
{
"data": [
{
"id": "eb93da1b58d9c1ad18ffe7637351d02b",
"type": "locations",
"attributes": {
"name": "Trader Bing's",
"tags": [],
"openHours": {
"1": [
{
"start": "2017-07-24T14:30:00Z",
"end": "2017-07-24T22:30:00Z"
}
],
"2": [
{
"start": "2017-07-25T14:30:00Z",
"end": "2017-07-25T22:30:00Z"
}
],
"3": [
{
"start": "2017-07-19T14:30:00Z",
"end": "2017-07-19T22:30:00Z"
}
],
"4": [
{
"start": "2017-07-20T14:30:00Z",
"end": "2017-07-20T22:30:00Z"
}
],
"5": [],
"6": [],
"7": []
},
"type": "dining",
"abbreviation": null,
"geometry": null,
"summary": "Zone: Austin Hall",
"description": null,
"address": null,
"city": null,
"state": null,
"zip": null,
"county": null,
"telephone": null,
"fax": null,
"thumbnails": [],
"images": [],
"departments": null,
"website": null,
"sqft": null,
"calendar": null,
"campus": "corvallis",
"giRestroomCount": null,
"giRestroomLimit": null,
"giRestroomLocations": null,
"latitude": "44.56505",
"longitude": "-123.282096"
},
"links": {
"self": "https://api.oregonstate.edu/v1/locations/eb93da1b58d9c1ad18ffe7637351d02b"
},
"relationships": null
}
]
}Generates a file that can be used with ElasticSearch for bulk insert.
Generates a file that can be used with ElasticSearch for bulk insert.
Elasticsearch won't be aware of Geo location and date type if the index template is not posted. This is also required to allow frontend api to use query parameters like lat/lon, isOpen.
Follow the below steps to post locations data to Elasticsearch
# Delete the existed index:
curl -s -XDELETE http://localhost:9200/locations/ ; echo
#Post index template to locations:
curl -s -H "Content-Type: application/json" -XPOST http://localhost:9200/_template/template_1 --data-binary "@ES-locations-index-template.json"; echo
#Post index template to services:
curl -s -H "Content-Type: application/json" -XPOST http://localhost:9200/_template/template_2 --data-binary "@ES-services-index-template.json"; echo
#Fetch dining/arcgis/extension JSON and post them to ES.The data-reset.sh bash script clears the Elasticsearch indices, reloads the template and reloads the data
Usage:
# Set local credentials to be used
export USER=secret
export PASSWORD=sauce
# Run bash script
./data-reset.sh