►
From YouTube: Adding a little Swagger to OData
Description
Swagger and the OpenAPI specification the manual work out of API documentation and make it easier for developers to share their APIs with the wold.
In this episode, Hassan Habib is back again with Jeremy to talk about Swagger support in the latest version of the OData package for ASP.NET Core.
[01:08] - The need for Swagger
[05:17] - Adding Swagger to an OData API application
[10:45] - Fixing the integration
ASP.NET Core web API help pages with Swagger / OpenAPI
https://docs.microsoft.com/aspnet/core/tutorials/web-api-help-pages-using-swagger?WT.mc_id=ondotnet-c9-cephilli
Swagger homepage
https://swagger.io/
OData Batch
https://devblogs.microsoft.com/odata/all-in-one-with-odata-batch?WT.mc_id=ondotnet-c9-cephilli
Exploring Graph Native Support for OData
https://devblogs.microsoft.com/odata/exploring-graph-native-support-for-odata?WT.mc_id=ondotnet-c9-cephilli
Supercharging your Web APIs with OData and ASP.NET Core
https://channel9.msdn.com/Shows/On-NET/Supercharging-your-Web-APIs-with-OData-and-ASPNET-Core?WT.mc_id=ondotnet-c9-cephilli
#aspnetcore #dotnet #odata #webapi #swagger
A
A
A
Hello
and
welcome
to
another
episode
of
on.net.
Today
we
are
going
to
add
a
little
bit
of
swagger
to
odata,
and
I've
got
my
friend
here,
hassan
who's,
going
to
tell
us
all
about
it.
Hassan
welcome
hi,
jeremy,
how
you
doing
I'm
doing
great,
so
we've
done
a
few
episodes
on
odata
and
we
covered
some
background
on
what
it
does.
We
talked
about
endpoint
routing,
but
there's
some
new
functionality.
I
think
you
want
to
talk
about
today,
so
why
don't
you
walk
us
into
what
this
is
all
about?.
B
Yeah
absolutely
so
one
of
the
most
important
thing
when
you
are
building
an
api
is
your
ability
to
communicate
the
capabilities
of
that
api
to
the
outside
world,
to
both
machines
and
people
so
developers,
you
know
developers
who
are
familiar
with
trying
to
integrate
with
an
api,
let's
say
sending
emails
or
making
payments
whatever
the
case
may
be,
it's
very
very
common
today
that
the
common
contract
between
an
api-
you
know
integrator
or
consumer,
an
api
developer.
Is
this
swagger?
B
B
I
don't
know
really
so
much
about
the
history
behind
the
name,
but
I
think
it's
a
pretty
cool
name
and
what
swagger
basically
is
it
tells
the
developers
that
want
to
consume
an
api.
You
know
what
are
the
capabilities
of
the
api
that
you
want.
They
want
to
work
with
what
they
can
and
can't
do.
What
are
the
limitations
and
very
detailed
description
about
each
endpoint
and
what
what
the
expected
request
may
be,
whether
it's
a
post
or
a
put
or
get
endpoint.
So
that's
you
know
that's
what
swagger
is.
B
It
helps
people
integrate
with
apis
without
actually
having
to
look
at
the
source
code,
knowing
what
the
capabilities
are.
So
if
it's
a
proprietary
service,
they
don't
have
actually
have
to
look
into
it.
You
know
and
know
what
the
code
is
doing.
It
could
stay
proprietary,
it
could
stay
closed
source
but
still
be
able
to
integrate
with
it
and
and
benefit
from
it.
A
So,
basically,
to
frame
this
sort
of
for
the
wcf
days
when
we
had
the
simple
object:
access
protocol
right
when
you
name
your
protocol
simple
well,
you
know
it's
probably
going
to
be
anything,
but
so
we
had
whistles,
which
was
a
web
service,
discovery
language
I
think
yeah
and
we
had
clients
because
it
was
a
known
format
for
describing
the
api.
You
could
point
a
client
at
it
and
just
auto
generate
people
loved
it
right.
People
were
doing
apis
all
day
long.
A
Just
right
click
generate
my
client,
let's
go
to
town,
but
with
rest
there
was
no
there's
no
standard
like
there's
a
convention
for
how
to
use
rest,
but
I
don't
know
if
your
endpoint
supports
x,
y
or
z,
so
am
I
correct
in
in
sort
of
drawing?
I
know
it's
not
exactly
the
same,
but
this
is
sort
of
like
a
whistle
for
rest
endpoints.
It's
not
specific
data.
B
Very
yes,
very,
very
similar
to
wesdale
it's
not
specific
to
a
data.
It's
actually
today
we're
talking
about
swagger
with
odata,
just
to
kill
all
the
engineers
out
there.
The
people
are
excited
about
oh
data.
You
could
still
expose
your
own
data
endpoints
and
tell
the
world
about
your
your
odata
capabilities
without
having
to
like,
like
ideally
because
oh
data
fundamentally
changes
how
your
api
routing
works
right.
A
lot
of
people
have
been
running
into
you
know
the
question
of
how
how
do
I
enable
swagger?
Here
I
want
to
expose
my
api.
B
A
B
B
You
know
with
all
of
that,
and
it
also
enables
all
data,
as
you
can
see
here,
I'm
gonna
start
just
simply
by
running
the
application,
just
to
show
you
that
the
application
actually
can
provide
information
on
us,
I'm
just
going
to
click
run
here
and
go
to
my
postman.
Real,
quick.
Here's
postman
here
is
my
postman
instance.
B
So
this
is
the
end
point
here.
I'm
just
going
to
change
this
time.
I'm
just
going
to
go
ahead
and
hit
and
say,
since
this
is
a
get,
I'm
just
going
to
go
ahead
and
say,
give
me
the
id.
Instead,
you
know
so
it's
going
to
hit
that
endpoint
and
then
it's
going
to
basically
select
all
the
ids
of
all
the
students
that
are
in
the
database.
So
we
know
that
we
have
a
functional,
odata,
enabled
api
that
actually
works
and
it
actually
pulls
information.
B
Now
a
lot
of
people
wanted
to
add
swagger
to
that
and
they
ran
into
some
problems,
because
oh
data
is
different
from
anything
else.
Let's
go
through
the
normal
route
of
enabling
oh
data
on
a
normal
api
without
without
having
actually
all
data
running
in
there.
So
what
what?
What
people
basically
do
is
that
they
go
and
say
this.
This
is
my
services
and
then
I
want
to
add
swagger
jen
right.
Obviously
we
need
to
bring
in
the
dependency
in
here.
B
B
Yep
exactly
so
we're
just
going
to
go
in
heat.
Go
ahead
in
here.
This
is
the
this
is
the
normal
there's.
Nothing
else
related
to
odata
in
here
we're
just
enabling
swashbuckle
for
swagger
for
our
project.
So
I'm
just
going
to
go
ahead
and
install
this
library
in
here
it
should
be
pretty
straightforward.
B
All
right,
so
as
soon
as
I
enable
this
library
now
there's
a
couple
of
things
I
want
like
normally,
even
without
oh
data
being
enabled,
you
want
to
go
and
enable
to
add
swagger
generation
right.
So
I'm
going
in
here
and
then
in
here
I'm
going
to
describe
you
know
what
my
swagger
document
is
going
to
look
like
swagger
basically
provides
versioning.
B
I'm
just
going
to
go
ahead
and
say
the
title
of
my
document
and
all
of
this
I'm
going
to
show
you
what
what
all
of
this
look
like
as
soon
as
we
start
running
the
application.
So
this
is
obviously
version
one
like
I
said,
and
then
the
title
here.
I
know
it
could
be
literally
anything,
I'm
just
going
to
call
it
my
api
right
so.
A
B
Yep
absolutely
and
it's
actually
it's
actually
a
an
official,
microsoft
library
like
we
as
microsoft.
We
actually
provide
that
natively
if
you
actually
simply
just
go
ahead
to
the
definition
here.
You'll
see
that
this
is
something
that
we
officially
support.
We
want
it
to
come
out
of
the
box.
We
want
something
that
supports
our
asp.net
core
api.
So
that's
the
first
piece
now
the
second
piece
here
so
the
second
piece
in
here
is
that
we
want
to
go
and
enable
the
swagger
ap
sr
ui
right.
B
So
first
of
all,
I
want
to
add
in
in
here
the
usage
of
swagger
using
a
a
middleware,
so
the
middleware
basically
will
intercept
any
communications
and
try
to
render
these
communications
into
a
document,
and
now
I
want
to
put
that
document
out
there.
So
I'm
just
going
to
go
ahead
and
say:
use
swagger
ui
like
this.
B
And
in
the
swagger
endpoint
I
get
to
decide
which
endpoint
that's
going
to
be
loading,
my
swagger
document
and
you
get
to
do
whatever
you
want
in
here
from
a
standardization
standpoint.
You
could
just
go
ahead
in
here
and
say:
swagger
like
historically
speaking.
If
you
want
people
not
to
look
around
too
much,
you
could
just
say
swagger.json,
which
is
basically
where
everyone
would
be
looking
right
exactly
the
same
way
when
people
say
okay,
where
is
the
help?
B
It
would
be
slash,
api,
slash
help
and
if
that
was
a
little
bit,
okay,
showing
my
age
here
a
little
bit,
but
that
was
back
in
the
day.
People
said
you
know,
slash
help.
It
should
give
you
all
the
information
that
you
need,
maybe
status,
maybe
health
about
your
api,
so
normally
without
oh
data.
That
would
be
enough
for
us
to
actually
run
our
data
as
with
swagger.
B
B
What
the
coming
part
is,
the
part.
That's
a
little
bit,
you
know
we're
working
on,
you
know
making
it
a
part
of
the
middleware
and
whatnot.
What
we
basically
do
is
basically
we
add
for
matters
because
basically
swagger
doesn't
know
how
to
add
formatters
for
all
data.
We
need
to
add
the
formatter
for
all
data
type
right
and
it's
a
little
bit
of
a
complex
code,
but
it's
not
too
complex,
and
I
don't
expect
people
to
remember
off
the
top
of
my
head
of
their
heads
and
I
don't
remember
it
either.
B
What
I'm
going
to
do
here
is
that
I'm
just
going
to
add
a
simple
method,
and
I'm
just
going
to
go
here
and
say,
add
for
matters
right
and
add:
formatters
basically
takes
in
the
service
collection
right.
So
this
is
a
service
collection.
So
far,
so
good
one
tiny
part,
that's
a
little
bit
complex,
but
everything
else
should
be
fine,
which
is
basically
to
go
ahead
and
add
these
for
matters
the
code,
for
that
is
a
little
bit
a
little
bit
big.
B
You
know
how
to
render
a
an
o
data
document,
let's
just
pull
in
a
bunch
of
dependencies
in
here
which
is
basically
microsoft.net,
http
headers,
not
system.net
microsoft.net.
So
I'm
going
to
add
this
part
in
here
and
then
we
probably
need
system.link,
because
that's
what
of
type
is
offering
and
then
obviously
the
o
data
formatters,
which
is
microsoft
out
of
the
box
or
data
formats.
This
is
the
only
part,
that's
a
little
bit
icky
other
than
that.
The
wrist
should
be
pretty.
B
Yeah
and
now
I'm
just
gonna
pick
up
that
ad
ad
for
matters
in
here
and
just
put
it
all
the
way
at
the
top,
I'm
passing
in
the
service
today.
So
after
I
did
my
swagger
work,
I'm
just
gonna
add
in
the
sorry,
not
this
one,
the
services
collection.
So
all
the
way
up
here
and
then
I'm
just
going
to
pass
in
services
in
here.
B
B
So
here
is
my
web
page
and
if
I
go
back
here
and
say
swagger
moment
of
truth
ta-da
there
you
go
so
now
you
can
actually
render,
even
though
the
the
endpoint
that
actually
has
oh
data
enabled
is
this
guy,
and
this
is
where
the
formatter
piece
that
I'm
talking
about
it's
actually
basically
renders
you
know
all
the
possible
formats
that
you
may
need
to
render
a
no
data.
Endpoint
like
right
now,
if
I
say
try
out
and
click
execute,
you
know
it
should
render.
B
It
should
actually
render
all
the
odata
stuff
with
the
odata
context,
with
everything
else
in
between
one
one
little
tiny
thing
about
this,
so
basically
for
people
who
have
existing
apis
and
they
want
to
add
oh
data
to
it
and
they
want
their
apis
to
actually
still
support
swagger,
even
though
they
have
oh
data,
that's
the
way
to
get
it
going.
Unfortunately,
there
is
still
some
attempts
around
making
you
able
to
actually
pass
in.
Oh
data
queries,
that's
not
something
that
swashbuckle
offers
today
out
of
the
box.
A
How
many
lines
it
could
be?
Basically,
our
basic
crud
like
create,
read,
update,
delete,
endpoints,
get
auto
generated.
You
get
a
ui
that
not
only
lets
you
explore
the
api,
but
also
lets
you
experiment
with
it.
You
can
actually
inline
test
it
and
what
you're
saying,
though,
is
if
I
wanted
to
test
like
a
complex
query:
let's
say:
filter
students
only
draw
back
a
couple
fields,
etc:
that's
not
as
as
readily
accessible
through
the
swagger
definition.
B
Absolutely
absolutely-
and
you
know
just
just
to
give
it
a
try
out-
you
know
if
I
go,
and
just
I
want
to
show
people
that
you're
still
maintaining
your
existing
functionalities,
it's
just
a
simple
endpoint
that
searches
for
a
student
by
their
id
boom
put
the
id
here's.
Your
student
still
has
the
odata
context.
The
formatters
know
what
to
do
with
it.
Everything
just
works.
This
is
very
important
jeremy,
because
you
know
for
a
lot
of
people
that
have
some.
B
You
know
20
apis
and
they
want
to
add
this
one
tiny
functionality
to
the
top
of
it.
This
is
a
game
changer
for
them,
because
a
lot
of
people
might
say
you
know.
If
I
can't
expose
my
api,
I
can't
sell
my
endpoints.
I
can't
sell
subscribers.
I
can't
have
people
integrate
with
my
endpoints
until
I
can
show
swagger,
so
it
might
deter
them
away
from
using
odata,
but
now
that
you
can
see
just
simple
steps,
you
could
actually
put
it
in
there.
You
know
and
make
it
work.
A
So
I
have
a
request.
I
know
this
ui
is
generated
for
you
and
me
so
that
we
can
understand
the
api
and
do
that,
but
without
the
ui
there's
still
that
swagger.json
endpoint
right
and
that's
what
the
actual
specification
is.
The
ui
is
just
eye
candy
built
on
top
of
the
that
json
document.
Can
you
pull
up
the
let's
see
document.
B
B
A
B
Yep
and
I've
seen
I've
seen
multiple
so,
regardless
of
the
language,
whether
the
urgent
java,
javascript
or
whatever
the
language
may
be,
you
know
there
are
now.
You
know
standardized
parsers
that
can
go
through
this
and
build
the
client
for
you.
Out
of
the
box
like,
like,
I
said
it's
just
like
wizdl,
it's
like
the
wcf,
except
that
it's
more
agnostic
and
it's
more
flexible
than
whistle
and
and
these
previous
technologies
for
soap.
And
why
not.