russellalbin / resume
我的作为 Magento 2 模块的简历
dev-master
2019-02-16 06:32 UTC
This package is auto-updated.
Last update: 2024-09-16 19:03:35 UTC
README
- composer require russellalbin/resume dev-master
- php bin/magento module:enable RussellAlbin_Resume
- php bin/magento setup:upgrade
这是我作为 Magento 2 模块的简历
我试图把尽可能多的内容放入其中,因此你可以将我的简历视为 xml 文档(进行中)你还可以将其视为保存在自定义数据库表中的值(待定)你还可以使用 CLI 来查看
API 方法
<route url="/V1/resume" method="POST">
<service class="RussellAlbin\Resume\Api\ResumeRepositoryInterface" method="save"/>
<resources>
<resource ref="RussellAlbin_Resume::edit"/>
</resources>
</route>
<route url="/V1/resume/:resumeId" method="GET">
<service class="RussellAlbin\Resume\Api\ResumeRepositoryInterface" method="get"/>
<resources>
<resource ref="RussellAlbin_Resume::view"/>
</resources>
</route>
<route url="/V1/resume" method="PUT">
<service class="RussellAlbin\Resume\Api\ResumeRepositoryInterface" method="save"/>
<resources>
<resource ref="RussellAlbin_Resume::edit"/>
</resources>
</route>
<route url="/V1/resume/:resumetId" method="DELETE">
<service class="RussellAlbin\Resume\Api\ResumeRepositoryInterface" method="deleteById"/>
<resources>
<resource ref="RussellAlbin_Resume::edit"/>
</resources>
</route>
<route url="/V1/resume/search" method="GET">
<service class="RussellAlbin\Resume\Api\ResumeRepositoryInterface" method="getList"/>
<resources>
<resource ref="RussellAlbin_Resume::view"/>
</resources>
</route>
关于预期参数和返回值的 API 注释
/**
* Save Resume
*
* @param \RussellAlbin\Resume\Api\Data\ResumeInterface $resume
* @return int|null
*/
public function save(\RussellAlbin\Resume\Api\Data\ResumeInterface $resume);
/**
* Get Resume
*
* @param int $resumeId
* @return \RussellAlbin\Resume\Api\Data\ResumeInterface
*/
public function get($resumeId);
/**
* Get Resume by ID
*
* @param $resumeId
* @return \RussellAlbin\Resume\Api\Data\ResumeInterface
* @throws \Magento\Framework\Exception\NoSuchEntityException
*/
public function getById($resumeId);
/**
* Get product list
*
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
* @return \Magento\Catalog\Api\Data\ProductSearchResultsInterface
*/
public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
/**
* Delete Resume
*
* @param \RussellAlbin\Resume\Api\Data\ResumeInterface $resume
* @return bool
* @throws \Magento\Framework\Exception\CouldNotDeleteException
*/
public function delete(\RussellAlbin\Resume\Api\Data\ResumeInterface $resume);
/**
* Delete Resume by ID.
*
* @param mixed $resumeId
* @return bool
* @throws \Magento\Framework\Exception\NoSuchEntityException
* @throws \Magento\Framework\Exception\CouldNotDeleteException
*/
public function deleteById($resumeId);
POST 请求的示例有效载荷
{ "resume": {
"entity_id": "1",
"firstname": "Joe",
"lastname": "Smith",
"description": "A different description",
"email": "anewemail@whatever.com",
"objective": "Something Else",
"phone": "808-999-1212",
"skills": "computers, baseball, parking cars and walking on the snow"
}
}
PUT 请求的示例有效载荷
{ "resume": {
"firstname": "Sally",
"lastname": "Nihongo",
"description": "A girly description",
"email": "sally@abigcompany.com",
"objective": "Eating, swearing and drinking water",
"phone": "333-111-5555",
"skills": "Yelling, dusting, math and air soft gun repair"
}
}