指示器是用于路由和handler进行连接的，它可以指定该请求的method以及url，如果你初始化了一个api，那么此时它默认为get请求，url则是你的文件系统url

  1. import { useApi } from '@swordjs/sword-framework';
  2. import { ReqQuery, ReqParams, Res } from './proto';
  4. export const main = useApi<{
  5.   query: ReqQuery;
  6.   params: ReqParams;
  7.   res: Res;
  8. }>({
  9.   handler: (ctx) => {
  10.     return {
  11.       message: 'hello'
  12.     };
  13.   }
  14. });

如果你想让这个api同时支持get和post，那么就要显式的指定它们：

  1. import { useApi, Get, Post } from '@swordjs/sword-framework';
  2. import { ReqQuery, ReqParams, Res } from './proto';
  4. export const main = useApi<{
  5.   query: ReqQuery;
  6.   params: ReqParams;
  7.   res: Res;
  8. }>({
  9.   instruct: [Get(), Post()],
  10.   handler: (ctx) => {
  11.     return {
  12.       message: 'hello'
  13.     };
  14.   }
  15. });

如果这个api文件在api/list文件夹下，那么url就是/api/list，此时如果你想强制修改路由的url，可以在指示器中指定url，虽然这非常不推荐

  1. instruct: [Get('/rename'), Post()],

请注意⚠️ ，当你有多个指示器的时候，虽然它从功能上来说，是可以给多个指示器指定不同的url，比如这样

  1. instruct: [Get('/rename'), Post('/again')],

但是在sword实现中，它只会默认取第一个url，即/rename，因为目前在sword中，暂时不支持多指示器多路由这样的功能，并不是技术实现不了，而是因为，这太难维护了；假设一下，当你的项目有10，20个接口的时候，如果你强行设置的url和文件系统生成的url重合了，虽然sword会包容这样的边界情况，但是从维护角度上来说是非常不友好，为此，我专门开了一个issue来讨论这个权衡的问题

所以我们在sword中，应该暂时避免这种写法，尽量使用文件系统生成的url，在后续我们可能会用ide插件解决开发维护难度高的问题，我们现在尽量就使用最佳实践即可，如果你非要设置url，只用给第一个指示器设置path就可以了

  1. instruct: [Get('/rename'), Post()],

目前支持的指示器

  1. export type HttpInstructMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE';