{"id":14986565,"url":"https://github.com/giddyinc/mongoose-to-swagger","last_synced_at":"2026-04-02T02:04:57.813Z","repository":{"id":19516185,"uuid":"87220543","full_name":"giddyinc/mongoose-to-swagger","owner":"giddyinc","description":"Conversion library for transforming Mongoose schema objects into Swagger schema definitions.","archived":false,"fork":false,"pushed_at":"2023-05-24T15:30:57.000Z","size":1673,"stargazers_count":55,"open_issues_count":24,"forks_count":27,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-04-14T19:57:16.564Z","etag":null,"topics":["docs","documentation","documentation-tool","mongoose","open-api","open-api-specification","openapi-specification","swagger","swagger-js"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/giddyinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-04T18:19:15.000Z","updated_at":"2024-03-06T09:08:15.000Z","dependencies_parsed_at":"2024-09-11T19:55:12.369Z","dependency_job_id":"6054e644-ea03-4966-8af7-7f81aa50d9b7","html_url":"https://github.com/giddyinc/mongoose-to-swagger","commit_stats":{"total_commits":88,"total_committers":9,"mean_commits":9.777777777777779,"dds":0.3522727272727273,"last_synced_commit":"11125142cf8ced47e4bd9af2e66521bb115aa1a2"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giddyinc%2Fmongoose-to-swagger","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giddyinc%2Fmongoose-to-swagger/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giddyinc%2Fmongoose-to-swagger/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/giddyinc%2Fmongoose-to-swagger/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/giddyinc","download_url":"https://codeload.github.com/giddyinc/mongoose-to-swagger/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248476363,"owners_count":21110264,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","documentation-tool","mongoose","open-api","open-api-specification","openapi-specification","swagger","swagger-js"],"created_at":"2024-09-24T14:13:09.076Z","updated_at":"2026-04-02T02:04:57.736Z","avatar_url":"https://github.com/giddyinc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![NPM version][npm-image]][npm-url]\n[![Build Status][travis-image]][travis-url]\n[![Coverage Status][coveralls-image]][coveralls-url]\n\n# mongoose-to-swagger \n\nConversion library for transforming [Mongoose](http://mongoosejs.com/) schema objects into [Swagger](http://swagger.io) schema definitions.\n\n## Installation\n\n```sh\n$ npm install --save mongoose-to-swagger\n```\n\n## Overview\n\nConverts a mongoose model into a swagger schema.\n\n## Usage\n\n```js\nconst mongoose = require('mongoose');\nconst m2s = require('mongoose-to-swagger');\nconst Cat = mongoose.model('Cat', { name: String });\nconst swaggerSchema = m2s(Cat);\nconsole.log(swaggerSchema);\n```\n\n### Meta properties\n\nBy default, `description`, `enum`, and `required` fields are extracted from the mongoose schema definitions and placed into the correspoding swagger properties definitions. Additional meta props can be whitelisted using the props array on the options argument.\n\n```ts\n\nconst Cat = mongoose.model('Cat', { \n    name: {\n        type: String,\n        /**\n         * Custom Properties\n         * `description` is enabled by default\n         */\n        description: 'Name of the cat', // description is enabled by default\n        bar: 'baz' // custom prop\n    },\n    color: String\n});\n\nconst options = { \n    /**\n     * Whitelist of custom meta fields.\n     */\n    props: ['bar'],\n    /**\n     * Fields to omit from model root. \"__v\" and \"id\" are omitted by default with omitMongooseInternals (default: true)\n     */\n    omitFields: ['_id', 'color'], \n    /**\n     * Omit mongoose internals, omits mongoose internals from result (\"__v\", \"id\" - mongoose version field and virtual id field) (default: true)\n     */\n    omitMongooseInternals: false\n};\n\nconst swaggerSchema = m2s(Cat, options);\n\n```\n\n\n\n## Contributing\nWe look forward to seeing your contributions!\n\n\n## License\n\nMIT © [Ben Lugavere](http://benlugavere.com/)\n\n[npm-image]: https://badge.fury.io/js/mongoose-to-swagger.svg\n[npm-url]: https://npmjs.org/package/mongoose-to-swagger\n[travis-image]: https://travis-ci.org/giddyinc/mongoose-to-swagger.svg?branch=master\n[travis-url]: https://travis-ci.org/giddyinc/mongoose-to-swagger\n[coveralls-image]: https://coveralls.io/repos/giddyinc/mongoose-to-swagger/badge.svg?branch=master\n[coveralls-url]: https://coveralls.io/r/giddyinc/mongoose-to-swagger?branch=master\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiddyinc%2Fmongoose-to-swagger","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgiddyinc%2Fmongoose-to-swagger","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgiddyinc%2Fmongoose-to-swagger/lists"}