Skip to content

Commit

Permalink
Update documentation/api/swagger-spec.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Lingyun Cai <[email protected]>
  • Loading branch information
NingW101 and lingyuncai authored Sep 19, 2023
1 parent cd8f3ba commit af88073
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion documentation/api/swagger-spec.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This section will introduce how to set up swagger specification auto-generation
Generation
**********

In ``package.json``, ensure the ``swagger-autogen`` npm package definition has been added in the``devDependencies`` field, and the ``swagger-autogen`` script command has been added in the ``scripts`` field. Besides, the ``swagger.js`` file in root is the key configuration file of the ``swagger-autogen`` module, including the target file, endpoints source file and the schema definitions. More details are available `here
In ``package.json``, ensure the ``swagger-autogen`` npm package definition has been added in the ``devDependencies`` field, and the ``swagger-autogen`` script command has been added in the ``scripts`` field. Besides, the ``swagger.js`` file in root is the key configuration file of the ``swagger-autogen`` module, including the target file, endpoints source file and the schema definitions. More details are available `here
<https://github.com/swagger-autogen/swagger-autogen#usage-with-optionals>`_.

.. code-block:: shell
Expand Down

0 comments on commit af88073

Please sign in to comment.