openi-ict / api-builder
Implementation of the API Builder for OPENI
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 14
Forks: 2
Open Issues: 0
Language:CSS
Type:project
Requires
- php: >=5.4.0
- costa-rico/yii2-images: dev-master
- kartik-v/yii2-checkbox-x: dev-master
- kartik-v/yii2-grid: *
- kartik-v/yii2-icons: dev-master
- kartik-v/yii2-money: dev-master
- kartik-v/yii2-mpdf: dev-master
- kartik-v/yii2-widgets: *
- romdim/yii2-bootstrap-material: dev-material-version-0-2-2
- romdim/yii2-snackbarjs: dev-master
- yiidoc/yii2-timeago: *
- yiisoft/yii2: *
- yiisoft/yii2-bootstrap: *
- yiisoft/yii2-swiftmailer: *
- zircote/swagger-php: *
Requires (Dev)
- c006/yii2-migration-utility: dev-master
- warrence/yii2-kartikgii: dev-master
- yiisoft/yii2-codeception: *
- yiisoft/yii2-debug: *
- yiisoft/yii2-faker: *
- yiisoft/yii2-gii: *
Suggests
- raoul2000/yii2-bootswatch-asset: Easily choose bootstrap theme for bootswatch.
This package is not auto-updated.
Last update: 2024-04-13 14:29:19 UTC
README
OPENi API Builder is a web project that allows developers to add Objects and combine methods for use with the official OPENi API Framework.
DIRECTORY STRUCTURE
.docs/ contains Documents for building the API Builder (mockups etc.)
assets/ contains assets definition
commands/ contains console commands (controllers)
config/ contains application configurations
controllers/ contains Web controller classes
mail/ contains view files for e-mails
migrations/ contains migrations for the database to be configured automatically
models/ contains model classes
runtime/ contains files generated during runtime
tests/ contains various tests for the basic application (not yet fully charged)
vendor/ contains dependent 3rd-party packages
views/ contains view files for the Web application
web/ contains the entry script and Web resources
widgets/ contains additional widgets used in this app
REQUIREMENTS
The minimum requirement by this application template that your Web server supports PHP 5.4.0. Additional packages required are marked in the composer.json file.
INSTALLATION
Download the latest release or the zipped master source code from api-builder
into a directory named api-builder that is directly under the Web root.
Run a command prompt in that directory and type:
composer global require "fxp/composer-asset-plugin:1.0.0"
composer install
NOTE: If you do not have Composer, you may install it by following the instructions at getcomposer.org.
This will fetch all the required packages and save them in your vendor folder.
You can then access the application through the following URL:
http://localhost/api-builder/web/
NOTE: For having recommendation features in the API views, Elasticsearch should be installed from here.
CONFIGURATION
Database
Create a file config/db.php with real data, for example:
return [ 'class' => 'yii\db\Connection', 'dsn' => 'mysql:host=localhost;dbname=apiBuilder', 'username' => 'root', 'password' => '1234', 'charset' => 'utf8', ];
Or rename the dbSample.php with your actual data.
Then, open a terminal and run
yii migrate
to make all the tables in the database.
Also check and edit the other files in the config/ directory to customize your application.
If your website is different than http://localhost/api-builder/ , you need to update the url property of the js file in /web/js/swagger/site.js .
At last, you need to rename the /web/indexSample.php to /web/index.php for the application to work and comment out the environment lines if you are in production environment.
Elasticsearch
This request should be made to create the 'api-builder' index:
curl -XPUT http://127.0.0.1:9200/api-builder
curl -XPOST http://127.0.0.1:9200/api-builder/_close
Recommended setting setup:
curl -XPUT 'http://127.0.0.1:9200/api-builder/_settings' -d
'{
"settings": {
"index": {
"analysis": {
"filter": {
"stem_filter": {
"type": "stemmer",
"name": "english"
},
"low_filter": {
"type": "lowercase"
},
"synonym_filter": {
"type": "synonym",
"synonyms_path": "analysis/synonyms.txt"
},
"stop_filter": {
"type": "stop",
"stopwords_path": "analysis/stopwords.txt"
}
},
"analyzer": {
"analyzer": {
"type": "custom",
"tokenizer": "standard",
"filter": [
"low_filter",
"synonym_filter",
"stop_filter",
"stem_filter"
],
"char_filter": [
"html_strip"
]
}
}
}
}
}
}'
NOTE: This of course implies that you have a synonyms and stopwords texts in your elasticsearch/config/analysis/ folder. Samples can be found at the root folder of the project.
curl -XPUT 'http://127.0.0.1:9200/api-builder/api/_mapping' -d
'{
"api": {
"properties": {
"objects": {
"type": "nested",
"properties": {
"name": {
"type": "string",
"index": "analyzed",
"analyzer": "analyzer"
},
"description": {
"type": "string",
"index": "analyzed",
"analyzer": "analyzer"
},
"properties": {
"type": "nested",
"properties": {
"name": {
"type": "string",
"index": "analyzed",
"analyzer": "analyzer"
},
"type": {
"type": "string",
"index": "not_analyzed"
}
}
}
}
}
}
}
}'
curl -XPOST http://127.0.0.1:9200/api-builder/_open