简单的swagger规范,用于检索html网页

时间:2017-05-10 15:51:01

标签: swagger

我是swagger的新手,我试图制作一个非常简单的规范,只需要一个get方法来检索网页,这就是代码:

{
  "swagger": "2.0",
  "info": {
    "title": "example",
    "description": "Sample api to retrieve a web page.",
    "version": "0.1"
  },
  "host":"example.org", #"localhost:8080",
  "schemes": [
    "https"
  ],
  "paths": {
    "/":{
      "get":{
        "summary":"Return the web page.",
        "description":"",
        "produces":["text/html"],
        "responses":{
          "200":{
            "description":"OK",
          },
              "400":{
                "description":"Bad request"
              },
              "404":{
                "description":"Not Found"
              }
            }
          }
       }
    }
}

我正在使用swagger在线编辑器。

不幸的是,当我执行请求时,它没有返回网页,也没有返回我在规范中实现的状态代码,它在详细信息部分返回错误:

  

TypeError:无法获取

有人可以告诉我哪里错了吗?

谢谢。

1 个答案:

答案 0 :(得分:1)

要在Swagger online editor中使用“试用”按钮,您的API端点必须为CORS - 已启用。也就是说,您的服务器(example.orglocalhost:8080)必须配置为返回某些响应标头,以允许editor.swagger.io向您的服务器发出跨域请求。这在这里有更详细的解释:
https://github.com/swagger-api/swagger-ui#cors-support

配置CORS的方式取决于用于托管应用程序的服务器/框架。此页面包含一些常见Web服务器的说明:
https://enable-cors.org/server.html