Автоматически генерировать документацию из Rest API в express framework - PullRequest
0 голосов
/ 02 мая 2020

Я хотел бы создать документацию для моего API, чтобы потребитель мог это понять.

например:

const createUser = (req, res) => {
  const { username, password } = req.body

  const savedUser = saveUser(username,password)//This one use mongoose to save user to database

  res.status(200).json(saveduser)

}

В настоящее время я использовал Swagger для создания документации. Тем не менее, я должен создать метаданные для создания документации. Каждый раз, когда я меняю тело запроса и тело ответа, мне приходится обновлять метаданные для обновления документации. Есть ли у вас какие-либо инструменты для отслеживания тела запроса и тела ответа и его генерации в документацию?

Я только что искал самый быстрый способ создания документации, чтобы потребитель мог знать тело запроса и тело ответа с именем и тип данных.

...