Q&A (please complete the following information)

• Method of installation: [npm, dist assets]
• Swagger-UI version: [>=3.25.1]
• Swagger/OpenAPI versi

建议添加新功能：同步 Swagger 文档时直接从 Swagger 文档解析 Mock 数据模版定义。

如以下 Swagger 的 id 字段声明

"Account": {
    "type": "object",
    "properties": {
        "id": {
            "type": "integer",
            "x-mock-key": "1",
            "x-mock-value": "[1,2,3]"
        }
    }
}

解析后生成

"id|1": [1, 2, 3]

即解析文档中 properties 的 x-mock-key 和 x-mock-value 为

"id|{x-mock-key}": 

There is absolutely no documentation (other than "this is how you drop an existing file". What is the point of releasing such a product if you do not document it?

Description
To be able to optionaly remove the google fonts dependency on any page of the api-platform.

Example
Remove the google font stylesheet in line 8 in the file api-platform\core\src\Bridge\Symfony\Bundle\Resources\views\SwaggerUi\index.html.twig depending on a configuration variable.

Context
I'm working on an intranet application for a 100000+ employees company and

Is there any documentation regarding CORS preflight requests? Seems like these should automatically be configured based on the swagger definition.

I'm looking to return the verbs defined in swagger for my resources (paths) but I can't even find how to control "preFlightContinue" option.

Thanks in advance.

This is more of a development problem and does not affect users as it is with dev dependencies. When cloning the repository and running yarn, yarn warns about incorrect peer dependencies:

$ git clone https://github.com/apiaryio/dredd.git dredd-clean
Cloning into 'dredd-clean'...
remote: Enumerating objects: 54, done.
remote: Counting objects: 100% (54/54), done.
remote: Compressin

It would be nice to have a note or two on which OAS versions this project supports.
Similar to https://github.com/swagger-api/swagger-ui/#compatibility

cc @webron

The official API docs are here

https://developers.google.com/maps/documentation/geocoding/start

I wanted to know if it would be possible to add this API's Swagger doc (and that of similar Google APIs like this).

See: https://gist.github.com/ericelliott/f3c2a53a1d4100539f71

Advantages

See: https://medium.com/javascript-scene/you-might-not-need-typescript-or-static-types-aa7cb670a77b

• autocomplete and type inference with most IDEs
• doesn't require passing Log objects for every call (although it's encouraged)
• other non-required parameters (such as query) can be omitted
• much easier to a

Hi together,

I just started using swagger-jsdoc in my nodejs project using Typescript. It was kind of hard to figure out how to use it due to the transpilation process involved.

There are a few workarounds necessary to make it work:

• apis [...] has to point to files in the /dist directory due to the transpilation process
• Annotations (in the comments) to model classes are lost in the t

Is your feature request related to a problem? Please describe.
This project looks amazing, but I´m somewhat left with a no-clue of how I´m supposed to build up an API using this repository after the initial look. Is there any user guides about where to configure what and what to configure?

Describe the solution you'd like
Documentation with a walkthrough of how-to, for instance, deplo

Currently the example value can have a different data structure that is defined in the schema and the swagger-cli validate doesn't rise an error.

example:
    foo:
        bar: a
        baz: b
type: object
properties:
    foo:
        type: integer
        format: int32
        default: 0

I think it would be very useful if the example value would be validated against

I'm trying to generate document for following function

"Some code ommitted"
@swagger.operation(
        notes='some random note',
        responseClass=str,
        nickname='upload',
        parameters=[
          ],
        responseMessages=[
            {
              "code": 201,
              "message": "Created. The URL of the created blueprint should be in the Location h

Do you know how to UT a simple endpoint with Jest and Supertest when using swagger-express-middleware?

I want to unit test the very basic swagger-express-middleware walkthrough example:
https://apitools.dev/swagger-express-middleware/docs/walkthroughs/walkthrough.html

But the test is not work

One of the most frustrating aspects of Swagger 2 annotations is the removal of the class-level @Api annotation, which was logical, clear and easy to understand.

Can you please update the Petstore example to clearly show how to group related REST operations together. I looked at the Resource classes and there are no annotations at the class level whatsoever.

When I visit /swagger-stats/ui, it seems that request will stay in processing status for statistics.
And I see [api_all_request_in_processing_total] growing when I visit /swagger-stats/ui.
Is that correct? The swagger-stats version I used is 0.95.6.

• Guidance on adding a linter new rule-action (if none of the existing ones can perform the action, or be extended)
• Expand on guidelines re: keeping commits to logical areas of the code / individual packages where possible
• Use of conventional-commit standard going forward
• Advice not to include any package-lock.json changes PRs, for security reasons. File will be regene

I've really enjoyed using the tool for my project documentation.

In addition to API specs, however, I'm also hosting a lot of general software design documentation (that doesn't involve REST API paths at all, like class overview, state diagrams, execution concept & flow, etc.) using Markdown. Right now I'm using tags + x-tagGroups, where the description field for some tags can be hundreds an

Problem

• README.md is not good to include more detail content. Hosting web-based documentation can be a good solution. There is no hosting cost if we use static web generator and free hosting provider such as GitHub Pages, Netlify.

Solutions

Static Web Generators

• vuepress
• gitbook

The documentation for the --minify option states that after building the site using it one can deploy a complete version of the site by just uploading the index.html file and pub directory.

That seems to be incorrect. The build still generates references to particularly images within the source directory. These image URLs can't be fixed without patching the layout template. The whole `i

I have found in the documentation that response_schema.json and request_schema.json are optional.
I have OAS with defined response schema but the response_schema.json is not generated.

Unfortunately, I hav