처음으로 api document 작성중인데 이렇게 하면되나요? 스웨거에 시간쓰다가 시간이 없어서 이렇게 만들었는데 잘못된점 있나요?

Resource	Authorization	Get(read)	Post(store)	Put(update)	Delete(destroy)
api/v1/employees	Admin, manager	Show list of employees	create an employee
api/v1/employees/{id}	Get-> all	Show an employee		Update an employee	Delete an employee
api/v1/employees/{id}	Put, delete->admin, manager	Show an employee		Update an employee	Delete an employee
api/v1/employees/{id}/upload	All	Import files	Upload files
api/v1/employees/search?first-name=example,lastname=example	Admin, manager		Search by first name or last name
api/v1/employees/?state=on	Admin, manager	Show lists of employees who are currently online
api/v1/employees/{id}/addresses	Admin, manager	Show an address of the employee	Create an address of the employee
api/v1/employees/{id}/addresses/{id}	Admin, manager			Update an address	Delete an address
api/v1/employees/{id}/positions	Admin, manager	Show a position of the employee	Create a position for an employee
api/v1/employees/{id}/positions/{id}	Admin, manager			Update a position information	Delete a position

1 answer