django

package

v0.0.0-...-762485d Latest Latest Go to latest Published: Oct 27, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tangcent/apilot

Links

Open Source Insights

Documentation ¶

Overview ¶

Package django parses Django REST Framework views and URL patterns.

Index ¶

func Parse(sourceDir string) ([]collector.ApiEndpoint, error)
func ParseWithUnresolved(sourceDir string, depResolver collector.DependencyResolver, ...) ([]collector.ApiEndpoint, error)
type DRFTypeResolver
- func NewDRFTypeResolver(serializers map[string]SerializerModel) *DRFTypeResolver
type SerializerField
type SerializerModel

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Parse ¶

func Parse(sourceDir string) ([]collector.ApiEndpoint, error)

func ParseWithUnresolved ¶

func ParseWithUnresolved(sourceDir string, depResolver collector.DependencyResolver, unresolved *collector.UnresolvedSet) ([]collector.ApiEndpoint, error)

ParseWithUnresolved is Parse plus an optional dependency resolver that expands types declared by pip dependencies, and an optional sink that records type names the resolver could not expand. Both may be nil.

Types ¶

type DRFTypeResolver ¶

type DRFTypeResolver struct {
	// contains filtered or unexported fields
}

func NewDRFTypeResolver ¶

func NewDRFTypeResolver(serializers map[string]SerializerModel) *DRFTypeResolver

func (*DRFTypeResolver) BuildRequestBody ¶

func (r *DRFTypeResolver) BuildRequestBody(serializerName string) *model.ObjectModel

func (*DRFTypeResolver) BuildResponseBody ¶

func (r *DRFTypeResolver) BuildResponseBody(serializerName string) *model.ObjectModel

func (*DRFTypeResolver) ResolveActionSerializer ¶

func (r *DRFTypeResolver) ResolveActionSerializer(viewClassName string, action string, serializerClassName string) (requestSerializer string, responseSerializer string)

func (*DRFTypeResolver) ResolveHTTPMethodSerializer ¶

func (r *DRFTypeResolver) ResolveHTTPMethodSerializer(viewClassName string, httpMethod string, serializerClassName string) (requestSerializer string, responseSerializer string)

func (*DRFTypeResolver) ResolveSerializer ¶

func (r *DRFTypeResolver) ResolveSerializer(serializerName string) *model.ObjectModel

func (*DRFTypeResolver) SetDependencyResolver ¶

func (r *DRFTypeResolver) SetDependencyResolver(dr collector.DependencyResolver)

SetDependencyResolver attaches an optional resolver that expands serializer names found in pip dependency packages.

func (*DRFTypeResolver) SetUnresolved ¶

func (r *DRFTypeResolver) SetUnresolved(u *collector.UnresolvedSet)

SetUnresolved attaches a shared sink that records type names this resolver could not expand. It is optional; without it Resolve behaves as before.

func (*DRFTypeResolver) Unresolved ¶

func (r *DRFTypeResolver) Unresolved() map[string]int

Unresolved returns the type names this resolver failed to resolve, mapped to their occurrence counts.

type SerializerField ¶

type SerializerField struct {
	Name     string
	DRFType  string
	Required bool
	ReadOnly bool
	Many     bool
}

type SerializerModel ¶

type SerializerModel struct {
	Name              string
	Fields            []SerializerField
	EmbeddedTypes     []string
	MetaModel         string
	MetaFields        []string
	IsModelSerializer bool
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL