76 lines
3.7 KiB
Markdown
76 lines
3.7 KiB
Markdown
|
|
|
|
[](https://github.com/AutoMapper/AutoMapper/actions?query=workflow%3ACI)
|
|
[](https://www.nuget.org/packages/AutoMapper/)
|
|
[](https://myget.org/feed/automapperdev/package/nuget/AutoMapper)
|
|
|
|
### What is AutoMapper?
|
|
|
|
AutoMapper is a simple little library built to solve a deceptively complex problem - getting rid of code that mapped one object to another. This type of code is rather dreary and boring to write, so why not invent a tool to do it for us?
|
|
|
|
This is the main repository for AutoMapper, but there's more:
|
|
|
|
* [Microsoft DI Extensions](https://github.com/AutoMapper/AutoMapper.Extensions.Microsoft.DependencyInjection)
|
|
* [Collection Extensions](https://github.com/AutoMapper/AutoMapper.Collection)
|
|
* [Expression Mapping](https://github.com/AutoMapper/AutoMapper.Extensions.ExpressionMapping)
|
|
* [EF6 Extensions](https://github.com/AutoMapper/AutoMapper.EF6)
|
|
* [IDataReader/Record Extensions](https://github.com/AutoMapper/AutoMapper.Data)
|
|
* [Enum Extensions](https://github.com/AutoMapper/AutoMapper.Extensions.EnumMapping)
|
|
|
|
### How do I get started?
|
|
|
|
First, configure AutoMapper to know what types you want to map, in the startup of your application:
|
|
|
|
```csharp
|
|
var configuration = new MapperConfiguration(cfg =>
|
|
{
|
|
cfg.CreateMap<Foo, FooDto>();
|
|
cfg.CreateMap<Bar, BarDto>();
|
|
});
|
|
// only during development, validate your mappings; remove it before release
|
|
#if DEBUG
|
|
configuration.AssertConfigurationIsValid();
|
|
#endif
|
|
// use DI (http://docs.automapper.org/en/latest/Dependency-injection.html) or create the mapper yourself
|
|
var mapper = configuration.CreateMapper();
|
|
```
|
|
Then in your application code, execute the mappings:
|
|
|
|
```csharp
|
|
var fooDto = mapper.Map<FooDto>(foo);
|
|
var barDto = mapper.Map<BarDto>(bar);
|
|
```
|
|
|
|
Check out the [getting started guide](https://automapper.readthedocs.io/en/latest/Getting-started.html). When you're done there, the [wiki](https://automapper.readthedocs.io/en/latest/) goes in to the nitty-gritty details. If you have questions, you can post them to [Stack Overflow](https://stackoverflow.com/questions/tagged/automapper) or in our [Gitter](https://gitter.im/AutoMapper/AutoMapper).
|
|
|
|
### Where can I get it?
|
|
|
|
First, [install NuGet](http://docs.nuget.org/docs/start-here/installing-nuget). Then, install [AutoMapper](https://www.nuget.org/packages/AutoMapper/) from the package manager console:
|
|
|
|
```
|
|
PM> Install-Package AutoMapper
|
|
```
|
|
Or from the .NET CLI as:
|
|
```
|
|
dotnet add package AutoMapper
|
|
```
|
|
|
|
### Do you have an issue?
|
|
|
|
First check if it's already fixed by trying the [MyGet build](https://automapper.readthedocs.io/en/latest/The-MyGet-build.html).
|
|
|
|
You might want to know exactly what [your mapping does](https://automapper.readthedocs.io/en/latest/Understanding-your-mapping.html) at runtime.
|
|
|
|
If you're still running into problems, file an issue above.
|
|
|
|
### License, etc.
|
|
|
|
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.
|
|
For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
|
|
|
|
AutoMapper is Copyright © 2009 [Jimmy Bogard](https://jimmybogard.com) and other contributors under the [MIT license](LICENSE.txt).
|
|
|
|
### .NET Foundation
|
|
|
|
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).
|