sqshq/restfiddle

RESTFiddle

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!

Initial Design

Who Uses RESTFiddle

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

• BootSimply Solutions (http://bootsimply.com/)

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

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 : [email protected] / 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 2.6 Standard\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 2.6 Standard\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 2.6 Standard\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

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

• Spring (http://spring.io/)

• Hibernate (http://hibernate.org/)

• HttpComponents (http://hc.apache.org/)

• Logback (http://logback.qos.ch/)

• MongoDB (http://www.mongodb.org/)

• Tomcat (http://tomcat.apache.org/)

• jQuery (http://jquery.com/)

• Bootstrap (http://getbootstrap.com/)

• Backbone (http://backbonejs.org/)

• Underscore (http://underscorejs.org/)

• RequireJS (http://requirejs.org/)

• https://github.com/mar10/fancytree/

• https://code.google.com/p/google-code-prettify/

• https://github.com/isagalaev/highlight.js/

• https://github.com/brianreavis/selectize.js/

• https://github.com/vitalets/x-editable/

• http://fortawesome.github.io/Font-Awesome/

• http://glyphicons.com/

Contribute

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

• Make sure you have a GitHub Account
• Fork RESTFiddle from here : https://github.com/AnujaK/restfiddle
• Clone your fork
• Make your changes
• Make sure everything is working fine
• Format your code (see below)
• Submit a pull request

Code formatting :

• If you're an Eclipse user, use the following code formatter : https://github.com/AnujaK/restfiddle/blob/master/tools/restfiddle_code_formatter.xml
• You should also activate automatic formatting and organizing imports on save.

GitHub help :

• Forking a repo - https://help.github.com/articles/fork-a-repo
• Creating a pull request - https://help.github.com/articles/creating-a-pull-request
• Syncing a fork - https://help.github.com/articles/syncing-a-fork

Google Group :

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

Meetup Group :

http://www.meetup.com/RESTFiddle

Gitter :

https://gitter.im/AnujaK/restfiddle

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 Ranjan Kumar

Licensed under Apache License, Version 2.0