{"id":15091362,"url":"https://github.com/swagger-api/swagger-scala-module","last_synced_at":"2025-10-06T10:31:07.616Z","repository":{"id":28643035,"uuid":"32162135","full_name":"swagger-api/swagger-scala-module","owner":"swagger-api","description":"Swagger support for scala","archived":true,"fork":false,"pushed_at":"2022-09-14T15:32:52.000Z","size":82,"stargazers_count":103,"open_issues_count":7,"forks_count":54,"subscribers_count":26,"default_branch":"master","last_synced_at":"2024-11-14T13:59:26.012Z","etag":null,"topics":["openapi-specification","scala","swagger"],"latest_commit_sha":null,"homepage":null,"language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/swagger-api.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-03-13T14:58:25.000Z","updated_at":"2024-03-17T22:56:15.000Z","dependencies_parsed_at":"2022-07-13T14:21:05.228Z","dependency_job_id":null,"html_url":"https://github.com/swagger-api/swagger-scala-module","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagger-api%2Fswagger-scala-module","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagger-api%2Fswagger-scala-module/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagger-api%2Fswagger-scala-module/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/swagger-api%2Fswagger-scala-module/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/swagger-api","download_url":"https://codeload.github.com/swagger-api/swagger-scala-module/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235519935,"owners_count":19003201,"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":["openapi-specification","scala","swagger"],"created_at":"2024-09-25T10:40:36.756Z","updated_at":"2025-10-06T10:31:07.250Z","avatar_url":"https://github.com/swagger-api.png","language":"Scala","readme":"# Archived\n\nThis project is no longer supported\n\n# Swagger Scala Module\n\n[![Build Status](https://travis-ci.org/swagger-api/swagger-scala-module.svg?branch=develop)](https://travis-ci.org/swagger-api/swagger-scala-module)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.swagger/swagger-scala-module_2.11/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/io.swagger/swagger-scala-module_2.11)\n\nThe goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swagger removes the guesswork in calling the service.\n\nSwagger-scala-module is a pure scala module for use with the swagger framework.\n\nCheck out [Swagger-Spec](https://github.com/swagger-api/swagger-spec) for additional information about the Swagger project, including additional libraries with support for SpringMVC, other languages and more. \n\n## See the Wiki!\nThe [github wiki](https://github.com/swagger-api/swagger-core/wiki) contains documentation, samples, etc.  Start there.\n\n## Compatibility\nThis project is compatible with [swagger-core](https://github.com/swagger-api/swagger-core) 1.5.x or greater.\n\n## Usage\nTo enable the swagger-scala-module, include the appropriate version in your project:\n\n```\n  \"io.swagger\" %% \"swagger-scala-module\" % \"1.0.7-SNAPSHOT\"\n```\n\nWhich will include the proper cross-publish version of swagger-scala-module.\n\n\n## How does it work?\nIncluding the library in your project allows the swagger extension module to discover this module, bringing in the appropriate jackson library in the process.  You can then use scala classes and objects in your swagger project.\n\n## Treatment of `Option` and `required`\nAll properties, besides those wrapped in `Option` or explicitly set via annotations `@ApiModelProperty(required = false)`, default to `required = true`  in the generated swagger model. See [#7](https://github.com/swagger-api/swagger-scala-module/issues/7)\n\n## How to hide model properties\n`@ApiModelProperty(hidden = true)` does not work because Scala generates a field and a getter for public properties. The annotation will hide the getter, but the field of the same name will still be visible.\n\nTo hide the property, instruct the Scala compiler to annotate both the field and the getter:\n```scala\nimport io.swagger.annotations.{ApiModel, ApiModelProperty}\nimport scala.annotation.meta.{field,getter}\n\n@ApiModel\ncase class Foo(\n  @ApiModelProperty(value = \"This will not be hidden!\", hidden = true)\n  stillVisible: Int,\n\n  @(ApiModelProperty @field @getter)(value = \"A hidden property\", hidden = true)\n  actuallyHidden: String\n)\n```\n\n## Support\nThe following methods are available to obtain support for Swagger:\n\n- [The Swagger Google Group](https://groups.google.com/forum/#!forum/swagger-swaggersocket) - This would normally be your first stop to get support for Swagger. Here you can find previously asked question, and ask new ones. When asking a question, please provide as much information as you can regarding the environment you use (development language, library, versions.\n- The [Issues tab](https://github.com/swagger-api/swagger-scala-module/issues?state=open) - Please open feature requests and bugs here. If you're not sure you encountered a bug, or if it's a general usage question, please use the Google Group mentioned above.\n- IRC! you can find us on [freenode](http://webchat.freenode.net/?channels=swagger) in the channel #Swagger. You can talk with us directly there.\n\n\n## Get started with Swagger!\nSee the guide on [getting started with swagger](http://swagger.io) to get started with adding swagger to your API.\n\n\n### To build from source\n```\nsbt publishLocal\n```\n\n## Security contact\n\nPlease disclose any security-related issues or vulnerabilities by emailing [security@swagger.io](mailto:security@swagger.io), instead of using the public issue tracker.\n\nLicense\n-------\n\nCopyright 2016 SmartBear Software, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n---\n\u003cimg src=\"http://swagger.io/wp-content/uploads/2016/02/logo.jpg\"/\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswagger-api%2Fswagger-scala-module","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fswagger-api%2Fswagger-scala-module","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fswagger-api%2Fswagger-scala-module/lists"}