SIMBA_Android¶
This app allows the user to connect to a Swagger-based API of their choice and, using Retrofit, allow the user to both get information from and send information to the API.
Installation¶
- Hit the “Clone or Download” button in upper right corner of the github page
- Hit the “Download ZIP” button.
- “Extract the file” with your extractor of choice.
- Open Android Studio and click “Open an existing Android Studio Project.”
- Navigate to where the extracted project is and select the project directory of the project (the one that contains the “app” folder) and hit “OK.”
- After a brief install, Android Studio should open the project.
Prerequisites¶
Note
These are already packaged in the app when you clone it.
- Retrofit
- Swagger
Usage¶
There are several screens in the app¶
- TitleScreen | This is the main screen of the app, where you can access the other screens and select an account.
- Most Recent Audits Screen | This is the screen that displays the last 10 audits. You can click on any of them.
- Descriptive Screen | This is the screen that pops up whenever you click on one of the last 10 audits. It lists every element listed with the audit.
- Post Screen | This is the screen where you can post an audit. Fields can be left empty or populated when posting.
- More info for all of these screens in the section “More Info.”
Modifying/Setting up getting¶
- Change the baseURL variable in “TitleScreen.java” to your API of choice.
- Change the @GET and @POST commands in the “SimbaClient.java” Interface to commands relating to your chosen API.
- Add or delete as many elements relating to your API as needed, making new classes where applicable, such as in “GetSimba.java, Asset.java, and Item.java.”
- Change the names of the elements on the screens in order to fit the new data from your API.
More Info¶
TitleScreen¶
- From the Title Screen, you can access the others screens of the app.
- Tapping the “POST Button” will send you to the Post screen.
- Tapping the “AUDIT Button” will send you to the Most Recent Audits screen.
- Tapping the “Account Selector” at the top will show a list of all the accounts you can choose from.
Most Recent Audits¶
- From the Most Recent Audits Screen, you can see the ten most recent audits.
- If you dislike which way the audits are listed (newest to oldest), you can click the “REVERSE” button to show them oldest to newest.
- You can click on one of the “audit tabs” to access the Descriptive Screen for that audit.
- Or, you can press the “BACK” button at the top to go back to the Title Screen.
Descriptive Audits¶
- From the Descriptive Audits Screen, you can see all the elements associated with a particular audit, such as this description.
- Tapping an element will bring up a pop-up with the element in larger text, in case it is hard to read.
- Tapping either the CORRECT or INCORRECT button will verify the audit as either correct or incorrect.
- Tapping the “Account Selector” at the top will show a list of all the accounts you can choose from.
- Or, you can press the “BACK” button at the top to go back to the Most Recent Audit Screen.
Post¶
- From the Post Screen, you can create an audit and post it to the API.
- By tapping the white spaces, you can edit a certain field’s text to send to the API.
- By tapping the POST button, you can send all that you have typed to API.
- Tapping the “Account Selector” at the top will show a list of all the accounts you can choose from.
- Or, you can press the “BACK” button at the top to go back to the Title Screen.
