Project Ideas API: DOCS

Description

The purpose of the Project Ideas API is to generate project ideas when you don't know what to do. This API is capable of generating project ideas of different topics, different categories, and different projects.

Categories

There are 5 basic functions with the categories object. Create, delete, read, read one, and update.

Create category

The only value required to create a new category is a category name as the category id is auto incremented. The new category name should be posted with the key "category_name" in json format.

Delete category

The delete function deletes a category. The information that must be posted for this request is the category id of what you would like to change.

Read category

The read function returns all categories. No information is needed to send to this file.

Example

http://brennensager.com/AT/individual-project/api/category/read.php

Read One category

The read one function returns a single category. The category to read is set by using id and get.

Example

http://brennensager.com/AT/individual-project/api/category/read_one.php?id=4

Update category

The update files for this api are arguably the most difficult. All information about the category must be sent to properly update the category. This data includes category_id and category_name

API Files

Category

• category.php
• create.php
• delete.php
• read.php
• read_one.php
• update.php

Project

• project.php
• create.php
• delete.php
• read.php
• read_one.php
• update.php

Topic

• topic.php
• create.php
• delete.php
• read.php
• read_one.php
• update.php

Config

• core.php
• database.php

Shared

• utilities.php

App Files

Add

• add-category.php
• add-project.php
• add-topic.php

Delete

• delete-category.php
• delete-project.php
• delete-topic.php

Update

• update-category.php
• update-project.php
• update-topic.php

View

• view-category.php
• view-project.php
• view-topic.php

Other

• header.php
• index.php
• footer.php

Database Design

There are three basic tables that are a part of my project's database. One table to hold types of projects (poster, film, etc.), another table stores project topics (presidents, states, etc), and the final table holds project/topic categories (technology, environment, etc.).

Common Errors