An Enterprise-grade API Management Platform for Teams. RESTFiddle helps you design, develop, test and release APIs.
Clone or download
ranjan-rk Merge pull request #447 from DevFactory/release/multiple-code-improve…
…ments-fix-8

multiple code improvements: squid:CommentedOutCodeLine, squid:S1192, squid:S1854
Latest commit 5851bb3 Jun 20, 2016

README.md

RESTFiddle

Gitter

Build Status

An Enterprise-grade API Management Platform for Teams. RESTFiddle helps you design, develop, test and release APIs.

Some of the key features of this platform are:

  • Request Builder - Make HTTP requests with ease.
  • Request Tree - Organize requests in the form of a tree.
  • Collaboration - Add as many collaborators as you want from your team and work together on a project.
  • PDF Reports - Generate project status reports in PDF format.
  • Integration - RESTFiddle platform exposes APIs for everything it has.
  • History - Unlimited history/activity log.
  • Scheduler - Run API projects on predefined time intervals.
  • SendGrid - SendGrid integration to send notifications.
  • Cloud Deployment - It can be deployed over any server and can also be used as a cloud based hosted web application.
  • Private - Install it in your environment and own it completely. Work together with your team in your private network.
  • Database - Store everything in your database.
  • Swagger - Access RESTFiddle API documentation using Swagger UI.
  • Tagging - Tags provide a useful way to group related requests together.
  • Open Source - Fork it and build the features of your choice.
  • More - Security, Access Control, Notifications and much more.

A lot of powerful features coming soon!

Who Uses RESTFiddle

The following is a list of companies and projects using RESTFiddle:

Want to be added to this section? Email me at contact at bootsimply dot com.

Building From Source

Prerequisites
  • JDK 7 or later

  • Maven 3.0+

  • Gradle 2.4 (Optional)

  • MongoDB 3.x

Build
mvn clean install
Run
mvn spring-boot:run
Access

The build file is configured to download and use an embedded Tomcat server. So the application should be up and running by using just two commands mentioned above. Once the server is started, the application can be accessed using http://localhost:8080.

Default login email / password : rf@example.com / rf
Debug
mvn spring-boot:run -Drun.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000"

Note : To avoid java.lang.OutOfMemoryError: PermGen space, use the following command:

MAVEN_OPTS="-XX:PermSize=256m -XX:MaxPermSize=512m" mvn spring-boot:run 
MongoDB configuration:

Go to src/main/resources/env-development.properties and update mongodb properties. Here is how the sample configuration looks like:

mongodb.name=restfiddle

mongodb.host=localhost

mongodb.port=27017

mongodb.username=

mongodb.password=
Steps to re-build the database:
1. Stop RESTFiddle server, if running.
2. Start MongoDB, if not running.
	Here is the command I use : "C:\Program Files\MongoDB\bin\mongod.exe" --dbpath C:\Users\ANUJA\Documents\restfiddle\data
3. Connect to MongoDB.
	Here is one of the ways to connect to MongoDB : 
	Go to "C:\Program Files\MongoDB\bin" folder and run "mongo" command.
	Then run "use restfiddle" command and finally "db.dropDatabase()" command to delete the existing RESTFiddle database.
	Note : you will see following message on the command prompt : { "dropped" : "restfiddle", "ok" : 1 }
4. Start RESTFiddle application (mvn spring-boot:run) - This will create and initialize the database.
Steps to recover database:
Sometimes MongoDB doesn't start and shows message:
        old lock file: C:\Users\ANUJA\Documents\restfiddledata\data\mongod.lock. probably means unclean shutdown
Run repair operation to recover your database
	"C:\Program Files\MongoDB\bin\mongod.exe" --dbpath C:\Users\ANUJA\Documents\restfiddledata\data --repair
Most likely, your data will be repaired with the --repair option. In case it doesn't, delete the mongod.lock file and then run the above --repair command.
For Gradle Users:

Build war

Unix :

./gradlew clean war

Windows :

gradlew.bat clean war

Run

Unix :

./gradlew bootRun

Windows :

gradlew.bat bootRun

Debugging in Windows : Add the following to build.gradle file and then run the above command

applicationDefaultJvmArgs = [
    "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000"
]

Using MongoDB 3.x

Download the latest MongoDB version. After kappa release, RESTFiddle has enabled authentication and moved to version 3.0. To start using this, create a configuration file mongo.conf at a location.e.g. F:\restfiddledata. Create mongo.log file for logging e.g. F:\restfiddledata\log\ This is how configuration file looks like:

bind_ip = 127.0.0.1
 
port = 27017
 
quiet = true
 
dbpath=F:\restfiddledata\data0
  
logpath=F:\restfiddledata\log\mongo.log
 
logappend = true

Start MongoDB without authentication.

"C:\Program Files\MongoDB\Server\3.0\bin\mongod.exe" --config F:\restfiddledata\mongo.conf  

On another command prompt go to C:\Program Files\MongoDB\Server\3.0\bin and type command mongo. This opens Mongo Shell. Create user here.

use restfiddle
db.createUser({"user":"rf","pwd":"rf","roles":["dbOwner","read","readWrite"]})

Now stop the database and restart it so that it checks for authentication

"C:\Program Files\MongoDB\Server\3.0\bin\mongod.exe" --auth --config F:\restfiddledata\mongo.conf

Start the RESTFiddle application using the same command as earlier

mvn spring-boot:run -Drun.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000"

Deployment

You can deploy the war file to Tomcat 7.0.52, Jetty, or any other container, as long as it supports servlet 3.0.

Technology Stack

Contribute

You're interested in contributing to RESTFiddle? AWESOME. Here are the basic steps:

Code formatting :
GitHub help :
Google Group :

https://groups.google.com/forum/#!forum/restfiddle

Meetup Group :

http://www.meetup.com/RESTFiddle

Gitter :

https://gitter.im/AnujaK/restfiddle

Code Quality :

https://nemo.sonarqube.org/overview?id=com.restfiddle%3Arestfiddle

Releases

https://github.com/AnujaK/restfiddle/releases

Support

If you need help in setting up RESTFiddle for your Team/Organization, feel free to contact me at this email address.

Copyright and License

Copyright 2015 BootSimply Solutions

Licensed under Apache License, Version 2.0