BeAPI Framework Installation

Getting started with BeAPI is simple process. Below are the steps for installation and configuration of your Beapi API Automation Tool Suite...


Requirements

The BeAPI™ API Framework has the following project requirements:


Quick Start Installation

To quickly get started on a new project, type the following command to create a new project with the Beapi Framework Installed:

grails create-app name_of_your_app --profile org.grails.profiles:beapi:1.4.10

You should now have a project directory that looks something like this:

  • docs documentation
  • gradle gradle directory
  • grails-app directory for MVC of application
    • commands gradle commands directory
    • conf configuration directory
      • application.groovy application config file. DO NOT MOVE!!!
      • logback.groovy application log file. DO NOT MOVE!!!
      • beapi.groovy FILE TO BE MOVED TO '~/.beapi'
      • beapi.yml FILE TO BE MOVED TO '~/.beapi'
      • beapi_api.yml FILE TO BE MOVED TO '~/.beapi'
      • beapi_db.yml FILE TO BE MOVED TO '~/.beapi'
      • beapi_server.yml FILE TO BE MOVED TO '~/.beapi'
    • controllers/net/nosegrind/apiframework application controllers folder
    • domains/net/nosegrind/apiframework application domains folders
    • i18n unused
    • init Application initializtion folder
    • jobs cronjobs folder
    • services services folder
    • views views folder
  • src src folder
    • integration-test test folder
    • iostate io-state folder
      • Apidoc.json FILE TO BE MOVED TO '~/.beapi/.iostate'
      • Hook.json FILE TO BE MOVED TO '~/.beapi/.iostate'
      • IOState.json FILE TO BE MOVED TO '~/.beapi/.iostate'
      • Person.json FILE TO BE MOVED TO '~/.beapi/.iostate'
      • PersonRole.json FILE TO BE MOVED TO '~/.beapi/.iostate'
      • Role.json FILE TO BE MOVED TO '~/.beapi/.iostate'
      • Stat.json FILE TO BE MOVED TO '~/.beapi/.iostate'
      • Test.json FILE TO BE MOVED TO '~/.beapi/.iostate'
    • main application folder
  • build.gradle gradle build file
  • gradle.properties gradle properties file

Move Configuration Files

Once you have created your project, you will need to create a file in your home directory for your configuration files:

  1. Use the following commands in a shell to create you local config directory:
    mkdir ~/.beapi
    cd ~/.beapi
    mkdir ~/.beapi/.iostate

  2. Next move all files marked above in your 'grails-app/conf' directory (see above) to your newly created '~/.beapi/' directory.

  3. Next move all files marked above in your 'src/iostate' directory (see above) to your newly created '~/.beapi/.iostate' directory.

Now you are setup and can start configuring your environment...


Troubleshooting